paperless-ngx

Automate Paperless-ngx document uploads, searches, tagging, and bulk edits via REST API.

69|7|Updated Feb 8, 2026
One-click install
npx skills add https://github.com/jmagar/claude-homelab --skill paperless-ngx
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: paperless-ngx
Source: https://github.com/jmagar/claude-homelab/tree/main/skills/paperless-ngx
Command: npx skills add https://github.com/jmagar/claude-homelab --skill paperless-ngx

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires curl, jq, and includes scripts (resource) and references (resource) components.

What problem does it solve?

Paperless-ngx provides automated OCR, full-text search, and metadata-driven document management for private archives, but lacks ready-to-run programmatic control in Claude workflows. This skill offers a read-write interface to the Paperless-ngx API, enabling uploading, searching, tagging, updating metadata, archiving, and exporting documents from a self-hosted instance.

Core Features & Use Cases

  • Upload documents with OCR and metadata
  • Search, filter, and retrieve documents by content, tags, correspondent, and date
  • Manage tags, correspondents, and document types and perform bulk edits or deletions
  • Automation-ready workflows: integrate with scripts like paperless-api.sh, bulk-api.sh, and tag/correspondent helpers for batch operations
  • Use Case: Maintain a private archive of invoices, receipts, contracts with audit-friendly tagging and export options

Quick Start

Install Paperless-ngx, generate an API token, configure ~/.claude-homelab/.env with PAPERLESS_URL and PAPERLESS_API_TOKEN, then begin using the provided scripts to manage documents.

Frequently Asked Questions about paperless-ngx

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate document management tasks in Paperless-ngx?

Automating document management in Paperless-ngx involves using REST API endpoints to upload, search, tag, and bulk edit files. It requires curl and jq for scripting, token-based authentication, and environment configuration.

Can I bulk tag and update metadata for documents in a private archive?

Yes, you can bulk tag and update metadata for documents in a private archive. Provided scripts like bulk-api.sh and tag helpers execute batch operations to apply tags, correspondents, and document types across large libraries.

Do I need curl and jq to use the Paperless-ngx API for uploads?

Yes, you need curl and jq to interact with the Paperless-ngx API for uploads and searches. Curl handles the HTTP requests to the endpoints, while jq parses the JSON responses returned by the REST API.

What is the best way to search a self-hosted document archive by content and tags?

The best way to search a self-hosted document archive by content and tags is through REST API filtering. You can retrieve documents by full-text content, tags, correspondent, and date using API queries parsed with jq.

How does OCR work when uploading documents to a Paperless-ngx instance?

OCR works automatically when uploading documents to a Paperless-ngx instance via the API. The self-hosted server processes the uploaded files to extract text, enabling full-text search and metadata-driven management without manual intervention.

Are there limitations to managing large document libraries through the Paperless-ngx API?

Limitations of managing large document libraries through the Paperless-ngx API include relying on token-based authentication and environment configuration. Bulk operations depend on script orchestration, and you must ensure your self-hosted instance handles the API load.