The REST API

Paperless makes use of the Django REST Framework standard API interface. It provides a browsable API for most of its endpoints, which you can inspect at http://<paperless-host>:<port>/api/. This also documents most of the available filters and ordering fields.

The API provides 5 main endpoints:

  • /api/correspondents/: Full CRUD support.
  • /api/document_types/: Full CRUD support.
  • /api/documents/: Full CRUD support, except POSTing new documents. See below.
  • /api/logs/: Read-Only.
  • /api/tags/: Full CRUD support.

All of these endpoints except for the logging endpoint allow you to fetch, edit and delete individual objects by appending their primary key to the path, for example /api/documents/454/.

In addition to that, the document endpoint offers these additional actions on individual documents:

  • /api/documents/<pk>/download/: Download the original document.
  • /api/documents/<pk>/thumb/: Download the PNG thumbnail of a document.
  • /api/documents/<pk>/preview/: Display the original document inline, without downloading it.

Hint

Paperless used to provide these functionality at /fetch/<pk>/preview, /fetch/<pk>/thumb and /fetch/<pk>/doc. Redirects to the new URLs are in place. However, if you use these old URLs to access documents, you should update your app or script to use the new URLs.

Searching for documents

Paperless-ng offers API endpoints for full text search. These are as follows:

/api/search/autocomplete/

Get auto completions for a partial search term.

Query parameters:

  • term: The incomplete term.
  • limit: Amount of results. Defaults to 10.

Results returned by the endpoint are ordered by importance of the term in the document index. The first result is the term that has the highest Tf/Idf score in the index.

[
    "term1",
    "term3",
    "term6",
    "term4"
]

POSTing documents

The API provides a special endpoint for file uploads:

/api/documents/post_document/

POST a multipart form to this endpoint, where the form field document contains the document that you want to upload to paperless. The filename is sanitized and then used to store the document in the consumption folder, where the consumer will detect the document and process it as any other document.

The endpoint will immediately return “OK.” if the document was stored in the consumption directory.