Paperless-ngx Document Management for Openclaw

A powerful integration to programmatically manage documents, tags, and metadata within a Paperless-ngx instance.

oskarstark
v1.0.0
Jan 26, 2026
4
4.1k
0

Install & Download

1. ClawHub CLI

The fastest way to install a skill directly from the registry.

npx clawhub@latest install paperless-ngx

2. Manual Installation

Copy the skill folder to one of these locations

Global
~/.openclaw/skills/
Workspace
<project>/skills/

Priority: Workspace > Local > Bundled

3. Prompt Installation

Copy this prompt to OpenClaw to install it automatically.

Help me install paperless-ngx 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-ngx Document Management?

The Paperless-ngx skill for Openclaw Skills provides a robust interface for interacting with the Paperless-ngx REST API. It enables developers and power users to automate the lifecycle of their digital documents, from initial upload and OCR processing to advanced categorization and bulk metadata updates.

By leveraging Openclaw Skills, you can bridge the gap between your local file system or other digital inputs and your self-hosted document management system, ensuring a streamlined and organized archive. This skill handles everything from simple searches to complex document organization, making it an essential tool for high-efficiency digital workflows.

Paperless-ngx Document Management Use Cases

  • Automated document ingestion from external sources or local folders.
  • Programmatic tagging and correspondent assignment for incoming invoices or receipts.
  • Bulk updating document types or metadata for legacy files to maintain organization.
  • Searching and downloading specific document versions for report generation or external sharing.
  • Monitoring processing tasks and OCR status for newly uploaded files to ensure data integrity.

How Paperless-ngx Document Management Works

  1. The skill authenticates with your Paperless-ngx instance using a provided API token via the Authorization header.
  2. Users or automated agents initiate requests to specific API endpoints such as documents, tags, or correspondents.
  3. For uploads, the skill sends multipart/form-data containing the document file and optional metadata like titles or tags.
  4. The Paperless-ngx server processes the request, performing OCR or metadata updates, and returns a structured JSON response.
  5. For long-running processes like OCR, the skill can poll the task status endpoint to confirm completion and verify the document's state.

Paperless-ngx Document Management Setup

To get started with this skill for Openclaw Skills, configure the following environment variables in your environment:

export PAPERLESS_URL="https://paperless.example.com"
export PAPERLESS_TOKEN="your_api_token_here"

You can obtain your API token from the Paperless-ngx user settings dashboard. Ensure the URL includes the protocol (http/https) and no trailing slash.

Paperless-ngx Document Management Data Schema & Taxonomy

The skill interacts with several core entities within Paperless-ngx. The data is organized as follows:

Entity Key Fields Description
Document id, title, content, tags, correspondent The core document record and its extracted metadata.
Tag id, name, color, slug Organizational labels applied to documents for filtering.
Correspondent id, name, matching_algorithm The person or organization associated with a document.
Document Type id, name Categorization labels such as Invoice, Letter, or Receipt.
Task task_id, status, result Tracking for background processing like OCR or file consumption.

Paperless-ngx Document Management Advanced Features

  • Bulk operations support to set correspondents, document types, or modify tags across multiple records in one request.
  • Dual-download capability for retrieving either the original uploaded file or the archived, OCR-enhanced version.
  • Advanced search filtering using specific parameters like date ranges, tag IDs, and correspondent IDs.
  • Task status monitoring to track the progress of asynchronous document processing and file consumption.
  • Metadata patching for granular updates to existing documents without re-uploading files within the Openclaw Skills ecosystem.

SKILL.md


Loading

Related Openclaw Skills

METADATA

Github Stars: 0
forks: 0

Featured*