Self-Hosted & AutomationDocumentedScanned

paperless-ngx

Paperless-ngx document management: search, upload, tag, organize.

Share:

Installation

npx clawhub@latest install paperless-ngx

View the full skill documentation and source below.

Documentation

Paperless-ngx Skill

Manage documents in Paperless-ngx via its REST API using HTTP requests.

Configuration

Requires environment variables:

  • PAPERLESS_URL: Base URL (e.g., ) - PAPERLESS_TOKEN: API token from Paperless-ngx settings ## Authentication Include token in all requests: __CODE_BLOCK_0__ ## Core Operations ### Search Documents __CODE_BLOCK_1__ Filter options: correspondent__id, document_type__id, tags__id__in, created__date__gte, created__date__lte, added__date__gte. ### Get Document Details __CODE_BLOCK_2__ ### Download Document __CODE_BLOCK_3__ ### Upload Document __CODE_BLOCK_4__ Optional fields: title, created, correspondent, document_type, storage_path, tags (repeatable), archive_serial_number, custom_fields. ### Update Document Metadata __CODE_BLOCK_5__ ### Delete Document __CODE_BLOCK_6__ ## Organization Endpoints ### Tags __CODE_BLOCK_7__ ### Correspondents __CODE_BLOCK_8__ ### Document Types __CODE_BLOCK_9__ ## Bulk Operations __CODE_BLOCK_10__ Methods: set_correspondent, set_document_type, add_tag, remove_tag, delete, reprocess. ## Task Status After upload, check task status: __CODE_BLOCK_11__ ## Response Handling - List endpoints return {"count": N, "results": [...]} with pagination - Single objects return the object directly - Use ?page=2 for pagination - Add ?ordering=-created for sorting (prefix -` for descending)