skills.rest
NickChristensen
NickChristensenCOMMUNITY
Explore all skills by this author →
GitHub

paperless-ngx-api

Locate and explain Paperless-ngx API endpoints from the OpenAPI spec.

1|Updated Jan 10, 2026
Search Tags:#api#openapi#endpoint#curl#paperless-ngx#client-code
One-click install
npx skills add https://github.com/NickChristensen/ppls --skill paperless-ngx-api
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: paperless-ngx-api
Source: https://github.com/NickChristensen/ppls/tree/main/.agents/skills/paperless-ngx-api
Command: npx skills add https://github.com/NickChristensen/ppls --skill paperless-ngx-api

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill helps developers quickly identify and understand Paperless-ngx API endpoints by interpreting the OpenAPI specification and generating actionable guidance.

Core Features & Use Cases

  • Endpoint discovery: locate available API paths, methods, and parameters from the OpenAPI spec.
  • Example payloads: produce sample requests and response shapes to speed client integration.
  • Use Case: when building a new Paperless-ngx client, quickly validate endpoint coverage and craft curl or fetch requests.

Quick Start

Ask it to locate endpoint details from the OpenAPI spec and generate example requests.

Frequently Asked Questions about paperless-ngx-api

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

FAQPage Schema
How do I find available endpoints in the Paperless-ngx API?▼

Locate available Paperless-ngx API paths, methods, and parameters by extracting structured data directly from the OpenAPI specification. This approach helps developers quickly identify exact routes and requirements for client integration.

How do I generate sample requests for the Paperless-ngx API?▼

Generate sample Paperless-ngx API requests and response shapes by interpreting the OpenAPI spec. This speeds up client integration by providing actionable payloads for validating endpoint coverage.

What is the best way to build a client for the Paperless-ngx API?▼

Building a Paperless-ngx client is streamlined by using the OpenAPI spec to validate endpoint coverage and generate curl or fetch requests. This provides actionable guidance for shaping client code architecture.

Do I need the OpenAPI spec to look up Paperless-ngx API endpoints?▼

Yes, endpoint lookup requires the Paperless-ngx OpenAPI specification file located at references/paperless-ngx-rest-api.yaml. The Skill relies on this file and the yq tool for structured data extraction.

Can I use curl to test Paperless-ngx API endpoints?▼

Yes, you can validate Paperless-ngx API endpoints by crafting curl requests based on example payloads generated from the OpenAPI spec. This allows quick testing of sample requests and response shapes.

Related Skills

Explore More Software Engineering Skills→
spamschspamsch
29

paperless_assistant

Manage document search, upload, and metadata in Paperless-ngx.

Community
Basic
damacusdamacus
2

paperless-search

Search Paperless-ngx documents via REST API with text, tag, and correspondent filters.

Community
Intermediate
dapperdiversdapperdivers
1

paperless-ops

Search, update, and categorize documents in Paperless-ngx via REST API.

Community
Intermediate
jmagarjmagar
69

paperless-ngx

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

Community
Intermediate