Automate document uploads and categorization for your Paperless-ngx instance via a robust API integration.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install paperless-api
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install paperless-api using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is Paperless API Skill?
The Paperless API skill is a specialized integration designed for the Openclaw Skills ecosystem, enabling users to programmatically interact with Paperless-ngx. It bridges the gap between local document storage and your self-hosted management system, allowing for seamless transfers of invoices, contracts, and personal records directly through an AI agent or script. By leveraging this skill, developers can create highly efficient document pipelines that reduce manual entry and ensure consistent organization.
Paperless API Skill Use Cases
- Automating the upload of scanned PDF invoices to a self-hosted Paperless-ngx instance.
- Categorizing incoming work contracts with specific tags and document types automatically.
- Streamlining digital archival workflows by connecting local file paths to a central document database.
- Integrating document management into broader AI-driven productivity pipelines using Openclaw Skills.
How Paperless API Skill Works
- The user provides the Paperless-ngx host URL and a secure API key to establish a connection.
- The skill accepts a local file path along with optional metadata like title, tags, and document type.
- The tool initiates an authenticated request to the Paperless-ngx REST API using the provided credentials.
- The file is uploaded, processed by the OCR engine (if enabled on the server), and categorized within the Paperless-ngx dashboard automatically.
Paperless API Skill Setup
To begin using this skill within your Openclaw Skills environment, ensure you have your Paperless-ngx instance credentials ready. You will need your host URL and a generated API key from your user settings.
# Run the upload script with your parameters
python scripts/upload_document.py \
--file_path /path/to/my_document.pdf \
--host http://your-paperless-url:8000 \
--api_key your_api_key_here \
--title "Annual Report" \
--tags "finance,report" \
--document_type "Report"
Paperless API Skill Data Schema & Taxonomy
The skill interacts with the Paperless-ngx data model to ensure metadata is correctly mapped during the upload process. The following fields are utilized:
| Parameter | Type | Description |
|---|---|---|
| file_path | String | The absolute path to the local file for upload. |
| host | String | The base URL of your Paperless-ngx instance. |
| api_key | String | The authentication token for API access. |
| title | String | (Optional) Custom title for the document record. |
| tags | String | (Optional) Comma-separated list of labels to apply. |
| document_type | String | (Optional) The specific category for the file. |
Paperless API Skill Advanced Features
- Custom metadata tagging for granular document searchability and organization.
- Full compatibility with existing Openclaw Skills automation hooks.
- Support for custom document types to maintain high archival standards.
- Extensible script architecture for batch processing and multi-document uploads.
SKILL.md
Loading
Related Openclaw Skills
DeepContent
An AI-driven content engine that transforms text prompts into branded social media assets, event posters, and speaker cards using pre-defined recipes.
Viral Short-Form Video Factory
A comprehensive content engine that automates the research, scripting, and production of 30 viral short-form videos for TikTok, Reels, and YouTube Shorts.
ClawLockRank
A specialized skill designed to securely upload local security audit scores from ClawLock to a centralized ranking system.
Adyen Recurring API
An AI agent skill designed to manage Adyen recurring payment details, permits, and account updates through standardized API interactions.
Adyen Stored Value API
A specialized interface for the Adyen Stored Value API that enables AI agents to manage gift cards, balances, and transaction voids.
AI-Control-Protocol
A cognitive immune system for Openclaw that eliminates AI sycophancy and forces objective pushback using Madhyamaka epistemology.
Featured*
