ComPDF OCR
Overview
ComPDF OCR helps agents and teams unlock text from scanned PDFs, screenshots, photographed files, and other image-based documents. It supports OCR on both PDFs and image files, making it easier to extract readable text, recover structured content, and create searchable outputs for analysis, archiving, and workflow automation.
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 editable/searchable PDF |
pdf-to-editable-pdf-tool-guide |
| PDF text extraction |
pdf-to-txt |
| Image OCR to text |
image-to-txt |
| OCR language values |
ocr-languages |
Scope
Restrict this skill to OCR and OCR-derived text or searchable-PDF output. Use the matching conversion skill for other target formats.
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-ocr3description: Recognize and extract text from scanned PDFs and images with ComPDF OCR workflows. Use for OCR, searchable PDF generation, text recognition, table recognition, and scanned-document extraction requests.4---5
6# ComPDF OCR
7
8## Overview
9
10ComPDF OCR helps agents and teams unlock text from scanned PDFs, screenshots, photographed files, and other image-based documents. It supports OCR on both PDFs and image files, making it easier to extract readable text, recover structured content, and create searchable outputs for analysis, archiving, and workflow automation.
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 editable/searchable PDF | `pdf-to-editable-pdf-tool-guide` |
19| PDF text extraction | `pdf-to-txt` |
20| Image OCR to text | `image-to-txt` |
21| OCR language values | `ocr-languages` |
22
23## Scope
24
25Restrict this skill to OCR and OCR-derived text or searchable-PDF output. Use the matching conversion skill for other target formats.
26
27## Workflow
28
291. Identify the source file type, desired output, and requested operation.
302. Read `references/endpoint-index.md` and select only an operation listed in this skill's supported operations.
313. 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.
324. Prefer synchronous mode for small interactive work. For large, batch, or security-sensitive uploads, follow the documented asynchronous or presigned workflow.
335. 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.
346. 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.
357. 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.
36
37## API Key
38
39Use 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.
40
41When 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.
42
43## Maintainer
44
45Refresh the local official snapshot before release, then inspect the diff for renamed endpoints, changed fields, and changed enum values:
46
47```powershell
48python scripts/sync_official_api_reference.py
49```
majiayu000