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

1. Identify the source file type, desired output, and requested operation.
2. Read references/endpoint-index.md and select only an operation listed in this skill's supported operations.
3. 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.
4. Prefer synchronous mode for small interactive work. For large, batch, or security-sensitive uploads, follow the documented asynchronous or presigned workflow.
5. 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.
6. 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.
7. 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, 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