paperless-ngx

What This Skill Does

The Paperless-ngx skill enables the OpenClaw AI agent to interface directly with your self-hosted Paperless-ngx document management system. By leveraging the REST API, this skill allows the agent to perform a wide range of operations including searching for specific documents, uploading new files, downloading existing ones, and managing organizational metadata like tags, correspondents, and document types. It effectively bridges the gap between your natural language requests and your structured document archive, allowing for hands-free management of your paperwork.

Installation

To integrate this skill into your environment, run the following command in your terminal: clawhub install openclaw/skills/skills/oskarstark/paperless-ngx Ensure you have configured your environment variables PAPERLESS_URL and PAPERLESS_TOKEN before initialization to ensure the agent has authenticated access to your server.

Use Cases

This skill is perfect for users who want to digitize their paper trail efficiently. Typical use cases include:

• Automating the filing of digital invoices by automatically assigning correct tags and correspondents upon upload.
• Querying your entire database for specific historical records, such as finding a warranty document from two years ago by searching through metadata or OCR-indexed content.
• Bulk organization where you might need to sync tags across multiple documents or rename files based on document types.
• Retrieving specific PDFs directly into your current workspace for review without opening the web interface.

Example Prompts

1. "Search for all invoices from ACME Corp uploaded in the last month and tag them as 'Pending-Payment'."
2. "Upload the PDF located at /home/user/downloads/tax_form.pdf as a 'Tax Document' and add the tag '2023'."
3. "Find the document with ID 452 and download the archived version to my desktop."

Tips & Limitations

• Performance: Large document uploads or complex searches may take a moment; please be patient while the agent processes the network request.
• Accuracy: Since this skill relies on the Paperless-ngx API, ensure your IDs for correspondents and document types are correct. If you are unsure, ask the agent to 'list all document types' first.
• Authentication: Always keep your PAPERLESS_TOKEN secure. The agent will handle the Authorization header, but ensure your environment variables are not exposed in public configuration files.