PDFHQ logo

Documents

DocumentationTools & reference

Schema-backed API Explorer

Search the source-derived OpenAPI snapshot and inspect OpenAPI request fields and server-side examples in ten SDK languages plus cURL without exposing API keys.

Server-side API keys Signed storage uploads

Search public API endpoints#

80 / 80 discovered developer operations have checked-in schemas. Examples are generated from those schemas and are documentation examples. The optional API Lab below permits only selected read-only GET requests with an in-memory project key; it never performs chargeable operations.

A checked-in contract is not proof of a deployed feature. AI and signing operations may be gated or sandbox-only. See the provider and release guides.

Programming language

Choose a language · scroll horizontally for all 10 SDK languages

Schema includedAvailability restricted

View your shared HQ-credit wallet

Request contract — checked-in OpenAPI snapshot

Authentication: APIKeyHeader · Documented responses: 200, 422

No JSON request body declared.

Authenticated API Lab

Read-only · No credit consumption

Execute selected safe GET requests against the published PDFHQ API. A project key is held only in this tab's memory. Never paste provider credentials, payment credentials or a production key on a shared computer.

GET /v1/ai/billing/balance · curl
# Fill placeholders with account-owned IDs and valid values; review the schema before sending.
# Server-side only. No API key is sent to signed storage hosts.
curl -q --fail-with-body --proto '=https' --max-redirs 0 \
  -X GET 'https://api.pdfhq.io/v1/ai/billing/balance' \
  -H "x-api-key: ${PDFHQ_API_KEY:?set PDFHQ_API_KEY}"

After starting a task, upload and verify PDFs, review the credit quote, and get explicit approval before processing. API keys belong on your server, never on signed storage uploads. Examples require editing before use, and are not automatically tested against a running API.

SDKs and verified workflows

The downloadable ten-language SDKs currently cover the task API only, not the full AI, signing or workspace surface. Full-service generation requires a runtime-verified OpenAPI contract.

Download 10 task SDKs Upload → quote → process quickstart OpenAPI snapshot
PDFHQ logo

PDF tools and document intelligence. Prepare, understand and work with your documents.

© 2026 PDFHQ. All rights reserved.