Paperless-ngx
Use AI with Paperless-ngx to search archived documents, summarize extracted text and update document metadata.
Search document text and metadata, read archived records, update classifications, and retrieve original or archived files. The connection also supports document uploads, PDF operations, and archive administration according to your permissions.
Cosa può fare il tuo agente in Paperless-ngx
Azioni raggruppate per attività. Ogni gruppo elenca le azioni che chiama.
Summarize Archived Documents
Search the archive and read extracted text from selected documents.
- List Documents
- Get Document
Organize Document Metadata
Read current metadata before applying specified title or classification changes.
- Get Document
- Update Document
Retrieve an Archived File
Retrieve an archived document through a temporary download link.
- Download Document
Import and Prepare Document Files
Upload documents from file URLs, combine PDFs, or export selected records as a ZIP archive.
- Upload Document
- Merge Documents
- Bulk Download Documents
- Get Task
Attività da affidare al tuo agente
Compila le parti tra parentesi e collega l'eventuale seconda app indicata dall'attività.
Find Contract Renewal Terms
Search archived contracts and extract renewal dates and notice requirements from their text.
Find the archived contract for [supplier]. Summarize its renewal date and cancellation notice period, cite the document ID, and flag anything not stated in the text.
File an Invoice Consistently
Rename an invoice and add the selected tag while preserving its existing classification.
Rename document [ID] to [supplier — invoice number — date]. Add tag [tag ID], keeping its existing tags and other metadata.
Retrieve an Archived File
Retrieve an archived document through a temporary download link.
Get a download URL for document [ID], using its original upload.
Export Receipts for an Accountant
Find receipts for a period and package the original files into one ZIP download.
Find receipts dated [start date] through [end date] with tag [tag ID]. Package their original files into a ZIP and return the download link with the document list.
Azioni139
Tutte le azioni offerte dal connettore Paperless-ngx, con nome e id.
- List Documents
list_documentsList or search documents visible to the connected user, 25 per page by default. Filters mirror the Paperless-ngx query parameters: id, title, archive serial number, dates, correspondent, document type, storage path, tags, owner, custom fields, MIME type and content lookups can be combined; anything not modelled goes into additional_filters. query, text, title_search and more_like_id run a search-index query instead, returning results with __search_hit__ ordered by relevance, and only one of them may be used per call. Only root documents are listed; file versions appear inside each document's versions array. Requires the view_document permission. - Get Document
get_documentGet one document with its metadata, tags, custom fields, notes, file versions and duplicate_documents (other documents sharing the same checksum). content holds the extracted text of the latest version unless version selects another one. Requires the view_document permission and view access to the document. - Update Document
update_documentPartially update a document: title, content, correspondent, document type, storage path, tags, creation date, archive serial number, custom fields, inbox tag removal, owner and object permissions. Only the provided fields are sent (PATCH); tags and custom_fields replace the whole list. Changing owner or set_permissions requires being the owner or a superuser. The response carries the full permissions object. Requires the change_document permission and change access to the document. - Delete Document
delete_documentMove a document and all of its file versions to the trash. Trashed documents stay restorable until the configured trash delay (30 days by default) expires and are removed from the search index immediately. Requires the delete_document permission and delete access to the document. - Get Document Root
get_document_rootResolve the root document of any document id, including ids of file versions and trashed documents. For a root document the answer is its own id. Requires view access to the root document. - Get Document Metadata
get_document_metadataGet file-level metadata of a document: checksums, sizes, MIME type, media file names, whether an archived PDF exists, parser metadata (such as PDF info and XMP fields) of the original and archived files, and the detected content language. Reads the latest version unless version is given. Requires view access to the document. - Get Document Suggestions
get_document_suggestionsGet correspondent, tag, document type, storage path and date suggestions for a document from the matching rules and the trained classifier. Results are cached until the document or classifier changes. Requires change access to the document (403 otherwise). - Get Document Ai Suggestions
get_document_ai_suggestionsAsk the configured language model for a title, tags, correspondent, document type, storage path and dates for a document. Existing objects the model picked are returned as ids, new names it proposed are returned separately. Requires AI to be enabled on the instance: otherwise Paperless-ngx answers 400 AI is required for this feature, an invalid AI configuration yields 400 and a model timeout yields 503. The call blocks while the model answers, and requires change access to the document. - Download Document
download_documentDownload the file of a document and hand it back as a temporary connector file URL. By default the archived PDF is served when it exists, otherwise the original upload; original=true always serves the original. The preview endpoint of Paperless-ngx serves exactly the same bytes with an inline disposition, so it is not exposed as a separate action. Works for trashed documents and file versions. Requires view access to the document; files above 200 MiB are rejected. - Get Document Thumbnail
get_document_thumbnailDownload the WebP thumbnail of a document (or of one of its file versions) and hand it back as a temporary connector file URL. Requires view access to the document. - List Document Notes
list_document_notesList the notes attached to a document, newest first, each with its author. Requires the view_note permission and view access to the document. - Add Document Note
add_document_noteAdd a note to a document on behalf of the connected user and return the complete note list. Also bumps the document's modified timestamp and re-indexes it. Requires the add_note permission and change access to the document. - Delete Document Note
delete_document_noteDelete one note from a document and return the remaining notes. Requires the delete_note permission and change access to the document; a note id that does not belong to the document yields 404. - List Document Share Links
list_document_share_linksList the share links of a document that have not expired yet, newest first. Requires change access to the document (Paperless-ngx treats reading share links as a sharing operation). - Get Document History
get_document_historyGet the audit trail of a document: every logged create, update, delete and access entry for the document and its custom field values, newest first, with the changed fields and the acting user. Requires the audit log to be enabled on the instance (PAPERLESS_AUDIT_LOG_ENABLED, otherwise 400 Audit log is disabled), the auditlog.view_logentry permission, and the connected user must own the document, be a superuser, or the document must be unowned. - Email Document
email_documentSend one document as an email attachment through the mail server configured on the Paperless-ngx instance. The archived PDF is attached when it exists unless use_archive_version is false. Paperless-ngx routes this through its collection email endpoint with a single document id. Requires the view_document permission, view access to the document and a configured outgoing mail server (otherwise a 500 Error emailing documents). - Email Documents
email_documentsSend several documents as attachments of one email through the mail server configured on the Paperless-ngx instance. Archived PDFs are attached when they exist unless use_archive_version is false. Requires the view_document permission, view access to every document (403 otherwise) and a configured outgoing mail server (otherwise a 500 Error emailing documents). - Update Document Version
update_document_versionUpload a new file version for a document. The connector downloads fileUrl server side and posts it as multipart form field document; Paperless-ngx consumes it in the background as a new version of the root document, keeping title, tags and other metadata shared. Returns the Celery task id to poll with get_task. Requires the change_document permission and change access to the root document; unsupported file types are rejected with 400. - Delete Document Version
delete_document_versionPermanently delete one non-root file version of a document. The root (original) version cannot be deleted this way; delete the document instead (400 otherwise). Requires delete access to the root document. - Update Document Version Label
update_document_version_labelSet or clear the label of one file version of a document, including the root version. Requires change access to the root document.
Come si accede a Paperless-ngx
- Metodo di accesso
- Chiave APIProvide your Paperless-ngx API token and public instance URL.
- Ti serve
- Paperless-ngx 3.0 or newer serving API version 10, with document view or change permissions.