Download document file
paperless_download_documentDownload a document's file to your local disk and get the saved path. Choose original upload, OCR'd archive, or thumbnail preview.
Instructions
Save a document’s file to local disk and return the path. Use kind: "original" for the file as uploaded, "archive" for the OCR’d PDF paperless generated, "thumbnail" for a small preview image. Read the extracted text with paperless_get_document instead when you only need the words. Writes are confined to PAPERLESS_DOWNLOAD_DIR.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Document id. | |
| kind | No | Which rendition to fetch. | archive |
| version | No | Fetch a specific document version id. | |
| dest_path | No | Where to write, as a path inside PAPERLESS_DOWNLOAD_DIR — relative to it, or absolute and under it. Anything outside is refused. Defaults to the server-supplied filename. |