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.
- Prefer synchronous mode for small interactive work. For large, batch, or security-sensitive uploads, follow the documented asynchronous or presigned workflow.
- Resolve the API key before preparing the request. Read the first non-empty line from
COMPDF_API_KEY_FILE when set. Otherwise read %USERPROFILE%\.compdf\api_key on Windows, or ~/.config/compdf/api_key on macOS and Linux. Pass the value only as the x-api-key header; never put it in code, logs, examples, or output.
- Before an operation that overwrites, deletes, decrypts, applies permanent protection, or sends a document externally, identify affected files and obtain confirmation unless the user has already authorized it.
- 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.
API Key
Use one local, private key file so later ComPDF tasks do not require pasting an API key into chat. The file must contain only the API key on its first non-empty line. Do not create, commit, upload, or display this file.
When the selected file is absent, unreadable, or empty, direct the user to obtain a key at https://www.compdf.com/compdf-portal/signin?utm_source=github&utm_medium=referral&utm_campaign=compdf_skills_repo_en&ref_platform_id=github_compdfkit_skills_en, save it in the selected file, and retry.
Maintainer
Refresh the local official snapshot before release, then inspect the diff for renamed endpoints, changed fields, and changed enum values:
python scripts/sync_official_api_reference.py
1---2name: compdf-pdf-to-json3description: 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.4---5
6# ComPDF PDF to JSON
7
8## Overview
9
10ComPDF 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.
11
12Use this skill to select an official ComPDF Server API endpoint and prepare an accurate request plan for the supported operations below.
13
14## Supported Operations
15
16| Operation | Official page or index section |
17| --- | --- |
18| PDF to JSON | `pdf-to-json` |
19
20## Scope
21
22Produce JSON only. For a custom schema or field extraction, use a ComPDF document-extraction workflow instead of inventing fields.
23
24## Workflow
25
261. Identify the source file type, desired output, and requested operation.
272. Read `references/endpoint-index.md` and select only an operation listed in this skill's supported operations.
283. 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.
294. Prefer synchronous mode for small interactive work. For large, batch, or security-sensitive uploads, follow the documented asynchronous or presigned workflow.
305. Resolve the API key before preparing the request. Read the first non-empty line from `COMPDF_API_KEY_FILE` when set. Otherwise read `%USERPROFILE%\.compdf\api_key` on Windows, or `~/.config/compdf/api_key` on macOS and Linux. Pass the value only as the `x-api-key` header; never put it in code, logs, examples, or output.
316. Before an operation that overwrites, deletes, decrypts, applies permanent protection, or sends a document externally, identify affected files and obtain confirmation unless the user has already authorized it.
327. 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.
33
34## API Key
35
36Use one local, private key file so later ComPDF tasks do not require pasting an API key into chat. The file must contain only the API key on its first non-empty line. Do not create, commit, upload, or display this file.
37
38When the selected file is absent, unreadable, or empty, direct the user to obtain a key at `https://www.compdf.com/compdf-portal/signin?utm_source=github&utm_medium=referral&utm_campaign=compdf_skills_repo_en&ref_platform_id=github_compdfkit_skills_en`, save it in the selected file, and retry.
39
40## Maintainer
41
42Refresh the local official snapshot before release, then inspect the diff for renamed endpoints, changed fields, and changed enum values:
43
44```powershell
45python scripts/sync_official_api_reference.py
46```
majiayu000