Overview
This node integrates with the Paperless-ngx document management system, allowing users to manage documents and related resources. Specifically, for the Document - Create operation, it enables uploading a new document file into Paperless-ngx. This is useful in scenarios where you want to automate document ingestion from various sources, such as scanned files, email attachments, or generated reports, directly into your document management system.
For example, you could use this node to automatically add invoices or contracts received via email into Paperless-ngx for further processing and archiving.
Properties
| Name | Meaning |
|---|---|
| File | The binary file data to upload as a new document. This must be provided as a reference to binary data available on the input item. |
Output
The output JSON contains a single field:
task_id: An identifier returned by Paperless-ngx representing the asynchronous task created to process the uploaded document. This can be used to track the status of the document ingestion.
No binary data is output by this node.
Example output JSON:
{
"task_id": "some-task-identifier"
}
Dependencies
- Requires an API key credential for authenticating with the Paperless-ngx API.
- The node expects the Paperless-ngx instance URL to be configured in the credentials.
- Input items must contain the binary file data referenced by the "File" property name.
Troubleshooting
- Missing or invalid file data: If the specified file property does not exist or is not valid binary data, the node will throw an error. Ensure that the input item contains binary data under the given property name.
- Authentication errors: If the API key or domain is incorrect or missing, requests to Paperless-ngx will fail. Verify the credential configuration.
- API endpoint errors: If the Paperless-ngx server is unreachable or returns an error, the node will throw an error. Check network connectivity and server status.
- Task ID missing: If the response from Paperless-ngx does not include a task ID, the upload may have failed silently. Review the API response and logs.