| name | compdf-pdf-to-json |
| description | Convert PDF content into structured JSON with ComPDF. Use when PDF text, tables, images, and structured content must feed an AI pipeline, application, or system integration. |
ComPDF PDF to JSON
Overview
ComPDF PDF to JSON is built for teams that need machine-readable output from PDF files. It extracts text, tables, images, and structured content into JSON, helping AI agents, internal systems, and automation platforms consume PDF data more reliably than raw text or manual copy-paste workflows.
Use this skill to select an official ComPDF Server API endpoint and prepare an accurate request plan for the supported operations below.
Supported Operations
| Operation | Official page or index section |
|---|
| PDF to JSON | pdf-to-json |
Scope
Produce JSON only. For a custom schema or field extraction, use a ComPDF document-extraction workflow instead of inventing fields.
Workflow
- Identify the source file type, desired output, and requested operation.
- Read
references/endpoint-index.md and select only an operation listed in this skill's supported operations.
- Read the matching heading in
references/official-api-reference.md. Use its exact endpoint path, request fields, request mode, and response fields; do not infer unsupported options.
- Include
sourceType=5 in every final ComPDF API request. Treat it as an integration routing parameter and include it in request details when the user asks for them.
- Prefer synchronous mode for small interactive work. For large, batch, or security-sensitive uploads, follow the documented asynchronous or presigned workflow.
- Resolve credentials only from
api_key in the directory containing this SKILL.md. Read its first non-empty line. Do not inspect environment variables or any other local path. If the file is absent, unreadable, or empty, ask the user to provide an API key, then create or replace only this skill-local api_key file after the user confirms storage. Do not display, log, commit, or include the key in requests examples or final output.
- Before uploading a document to ComPDF, identify the affected files and destination, and obtain confirmation unless the user has explicitly authorized that upload. Also obtain confirmation before operations that overwrite, delete, decrypt, or apply permanent protection.
- Return the endpoint, method, content type, complete request fields, expected task/result fields, and the next polling or download step. Preserve original files unless replacement is explicitly requested.
Credentials
Store only the current skill's API key in the sibling api_key file. This file is private runtime state and must be excluded from version control and skill publishing.
To obtain an API key, register or sign in at ComPDF Portal. On first use, provide the key when requested and confirm storing it in the skill-local api_key file; later requests reuse that stored key.
