paperless-query

Automate document search, upload, tagging, and management in Paperless-NGX via REST API.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/DisruptionEngineer/build-useful-skills --skill paperless-query
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: paperless-query
Source: https://github.com/DisruptionEngineer/build-useful-skills/tree/main/paperless-query
Command: npx skills add https://github.com/DisruptionEngineer/build-useful-skills --skill paperless-query

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Paperless-NGX users often need to locate, upload, tag, and organize documents across a REST API. This Skill provides a comprehensive workflow to interact with Paperless via the REST endpoints, reducing manual effort and errors.

Core Features & Use Cases

  • Full-text search across documents and metadata using the REST API.
  • Tag, tag management, and filtering by correspondents and document types.
  • Upload documents with automatic tagging and optional metadata (title, tags, and correspondent).
  • Retrieve statistics, recent additions, and document lists for reporting and archival planning.

Quick Start

Authenticate with PAPERLESS_TOKEN and begin issuing API calls to search, upload, or manage documents in your Paperless-NGX instance.

Frequently Asked Questions about paperless-query

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

FAQPage Schema
How do I automate document search in Paperless-NGX using the REST API?

Automate document search in Paperless-NGX by issuing REST API calls with a PAPERLESS_TOKEN for full-text queries across documents and metadata, reducing manual effort and errors.

How do I upload documents with automatic tagging to Paperless via API?

Upload documents with automatic tagging to Paperless via API by sending files through REST endpoints with optional metadata like title, tags, and correspondent. This requires a PAPERLESS_TOKEN for authentication.

Do I need an API token to manage documents in Paperless-NGX?

Yes, you need an API token to manage documents in Paperless-NGX. A PAPERLESS_TOKEN environment variable is required for authentication, and a PAPERLESS_URL is optional for specifying your instance.

Can I filter Paperless documents by correspondent and date range using REST endpoints?

Yes, you can filter Paperless documents by correspondent and date range using REST endpoints. The API supports filtering by tags, correspondents, document types, and date ranges for targeted document retrieval.

What is the best way to retrieve document statistics from Paperless-NGX?

Retrieve document statistics from Paperless-NGX by using REST API endpoints to gather recent additions and document lists. This provides data for reporting and archival planning without manual querying.

Are there limitations to managing tags in Paperless through the REST API?

Managing tags in Paperless through the REST API is limited to the capabilities of the standard REST endpoints provided by Paperless-NGX. Operations include creating, updating, and filtering tags via authenticated API calls.