Paperless

Paperless-ngx keeps scanned documents. This shows recent documents, and lets the assistant search and read them, and file what you attach or paste.

Set it up

config.yaml

integrations:
  paperless:
    type: paperless
    url: http://paperless:8000
    token: ${PAPERLESS_TOKEN}
    href: https://docs.example.com

layout:
  - title: Apps
    widgets:
      - paperless.recent

Option	Type	Default	What it does
url	URL	required	Where the service answers, from Valet’s side.
token	string	required	An API auth token, best from a separate user with view permissions. Use ${VAR}.
href	string	optional	Where the card links to, when that differs from url.

Widgets

One widget. Its key is paperless.recent, using the instance name from your config.

Documents

paperless.recent · shelf card · refreshes every 5 minutes while the page is open.

Small

Wide

Medium

Large

In chat

Tall draws the same as medium, so it isn't shown. Only the empty space changes.

States

No documents yet

Can't reach it

Assistant tools

What the assistant can use, once its access level allows it. Read tools run freely. Everything else asks first.

Tool	Access	What it does
docs_search	read	Search the person’s documents in Paperless (full text: letters, bills, receipts, contracts, statements, IDs…).
docs_read	read	Read one document’s text (OCR) and details by id, to answer a question about it.
docs_add	write	File something in Paperless: a file the person attached in chat (pass its file id from the message), or text they pasted (pass text; it’s saved as a text document).

Year in review

Slides this integration adds to the recap.

You keep 3,412 documents