How do I install the Paperless Ngx API skill?

Run npx skillmds@latest add nickchristensen/paperless-ngx-api in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Paperless Ngx API safe to use?

This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. Capability flags: docs only. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Paperless Ngx API?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Paperless Ngx API free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Paperless Ngx API?

NickChristensen (@nickchristensen) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Paperless Ngx API by nickchristensen

Name: Paperless Ngx API
Rating: 4.666666666666667 (3 reviews)
Author: NickChristensen

Paperless Ngx API

Use when working with the Paperless-ngx REST API; looking up endpoints, request/response shapes, auth requirements, filtering/pagination, or generating example requests/responses from the OpenAPI spec. Trigger for tasks involving Paperless-ngx API integrations, client code, curl examples, or schema details.

File contents

Paperless Ngx Api

Overview

Use the bundled OpenAPI spec to answer endpoint questions, build requests, and validate payloads for the Paperless-ngx REST API.

Required dependency

yq (required) for YAML parsing and targeted extraction from the OpenAPI spec.

Core workflow

Open the OpenAPI spec in references/paperless-ngx-rest-api.yaml and extract only the needed sections.
Use yq to find the relevant paths, operations, parameters, schemas, and response shapes.
Produce the requested output (endpoint lookup, example request/response, client code shape, or validation notes).

Reference usage

The OpenAPI spec is stored at references/paperless-ngx-rest-api.yaml. Prefer yq for targeted extraction instead of loading the entire file.

Common yq snippets (adjust selectors based on the spec structure):

List paths:
- yq '.paths | keys' references/paperless-ngx-rest-api.yaml
Inspect an operation:
- yq '.paths["/api/documents/"].get' references/paperless-ngx-rest-api.yaml
Find a schema:
- yq '.components.schemas | keys' references/paperless-ngx-rest-api.yaml
View a schema definition:
- yq '.components.schemas.Document' references/paperless-ngx-rest-api.yaml

Output expectations

Be explicit about HTTP method, path, required headers, and auth scheme from the spec.
Call out pagination, filtering, and ordering parameters when present.
For upload endpoints, specify content type and multipart field names from the spec.
When unsure, verify in the spec before answering.

Resources

references/

paperless-ngx-rest-api.yaml (OpenAPI spec)

---name: paperless-ngx-apidescription: Use when working with the Paperless-ngx REST API; looking up endpoints, request/response shapes, auth requirements, filtering/pagination, or generating example requests/responses from the OpenAPI spec. Trigger for tasks involving Paperless-ngx API integrations, client code, curl examples, or schema details.---# Paperless Ngx Api## OverviewUse the bundled OpenAPI spec to answer endpoint questions, build requests, and validate payloads for the Paperless-ngx REST API.## Required dependency- `yq` (required) for YAML parsing and targeted extraction from the OpenAPI spec.## Core workflow1. Open the OpenAPI spec in `references/paperless-ngx-rest-api.yaml` and extract only the needed sections.2. Use `yq` to find the relevant paths, operations, parameters, schemas, and response shapes.3. Produce the requested output (endpoint lookup, example request/response, client code shape, or validation notes).## Reference usageThe OpenAPI spec is stored at `references/paperless-ngx-rest-api.yaml`. Prefer `yq` for targeted extraction instead of loading the entire file.Common `yq` snippets (adjust selectors based on the spec structure):- List paths: - `yq '.paths | keys' references/paperless-ngx-rest-api.yaml`- Inspect an operation: - `yq '.paths["/api/documents/"].get' references/paperless-ngx-rest-api.yaml`- Find a schema: - `yq '.components.schemas | keys' references/paperless-ngx-rest-api.yaml`- View a schema definition: - `yq '.components.schemas.Document' references/paperless-ngx-rest-api.yaml`## Output expectations- Be explicit about HTTP method, path, required headers, and auth scheme from the spec.- Call out pagination, filtering, and ordering parameters when present.- For upload endpoints, specify content type and multipart field names from the spec.- When unsure, verify in the spec before answering.## Resources### references/- `paperless-ngx-rest-api.yaml` (OpenAPI spec)

Frequently asked questions