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.
All API categories AI DOCUMENT-JOBS DOCUMENTS ESIGN TASK-TOOLS TASKS WEBHOOKS WORKSPACE
Programming language
Example notes languageEN FR DE ES PT ID NL IT TR PL Choose a language · scroll horizontally for all 10 SDK languages
cURL Python JavaScript TypeScript Go Java C# / .NET C++ Rust PHP Ruby
API operation (80 matching)
GET /v1/ai/billing/balance — View your shared HQ-credit wallet GET /v1/ai/billing/models — Discover curated PDFHQ AI models and priced availability GET /v1/ai/billing/prices — List active PDFHQ AI prices POST /v1/ai/billing/quotes — Quote PDFHQ AI usage in both currencies GET /v1/ai/billing/quotes/{quote_id} — Inspect an existing account-owned AI quote POST /v1/ai/edit-plans/from-job — Revalidate a paid AI page-edit suggestion against its original sealed PDF and issue a user-review token POST /v1/ai/edit-plans/preview — Preview deterministic plain-English PDF page changes without charging credits GET /v1/ai/jobs — List your AI document jobs POST /v1/ai/jobs — Start a quoted, HQ-credit AI document operation POST /v1/ai/jobs/invoices/batch.xlsx — Export up to ten already-completed invoice jobs into one review workbook GET /v1/ai/jobs/usage — Account-scoped AI job usage and token counts (no document content) DELETE /v1/ai/jobs/{job_id} — Delete a completed AI document result GET /v1/ai/jobs/{job_id} — Poll status and cited AI result GET /v1/ai/jobs/{job_id}/comparison.csv — Export cited contract changes for human review as a safe CSV GET /v1/ai/jobs/{job_id}/comparison.xlsx — Download a source-linked contract change review workbook GET /v1/ai/jobs/{job_id}/conversation — Read an owned, unexpired conversation's cited turns GET /v1/ai/jobs/{job_id}/evidence.csv — Export the cited source excerpts of an owned AI result for private human review GET /v1/ai/jobs/{job_id}/export.{fmt} — Download a private, citation-validated AI review result (JSON, PDF, DOCX or XLSX) GET /v1/ai/jobs/{job_id}/invoice-lines.csv — Export cited invoice line items for human review GET /v1/ai/jobs/{job_id}/invoice.csv — Export invoice fields for review as a safe CSV GET /v1/ai/jobs/{job_id}/invoice.xlsx — Download an account-scoped, evidence-linked invoice review workbook GET /v1/document-jobs — List recent account- and API-key-scoped document jobs POST /v1/document-jobs — Process uploaded PDFs asynchronously GET /v1/document-jobs/{job_id}/download-url — Get a temporary direct download URL POST /v1/documents/uploads — Create a direct PDF upload DELETE /v1/documents/uploads/{upload_id} — Delete an unused uploaded document GET /v1/documents/uploads/{upload_id} — Inspect an uploaded document POST /v1/documents/uploads/{upload_id}/complete — Verify and seal uploaded PDF GET /v1/documents/uploads/{upload_id}/evidence — Extract page-cited text from a verified PDF (limited preview) GET /v1/documents/uploads/{upload_id}/form-fields — Discover supported AcroForm field names, types and page numbers GET /v1/esign/envelopes — List your own signature requests POST /v1/esign/envelopes — Create an eSignature request draft DELETE /v1/esign/envelopes/{envelope_id} — Discard an unsent draft without contacting provider GET /v1/esign/envelopes/{envelope_id} — Get signature request status PATCH /v1/esign/envelopes/{envelope_id} — Edit an unsent signature draft using an exact draft version POST /v1/esign/envelopes/{envelope_id}/archive — Save a provider-completed signed PDF to private storage GET /v1/esign/envelopes/{envelope_id}/audit — Read account-scoped eSignature integrity and event receipt GET /v1/esign/envelopes/{envelope_id}/download-url — Issue short-lived private signed-document download URL POST /v1/esign/envelopes/{envelope_id}/remind — Send one sandbox signer reminder per 24 hours, without retries GET /v1/esign/envelopes/{envelope_id}/reminders — List private reminder attempt receipts without signer email addresses POST /v1/esign/envelopes/{envelope_id}/send — Send an explicitly approved sandbox signature request POST /v1/esign/envelopes/{envelope_id}/sync — Refresh a sandbox request from the signing provider without resending GET /v1/esign/envelopes/{envelope_id}/timeline — Read a privacy-safe signature request activity timeline POST /v1/esign/envelopes/{envelope_id}/validate — Validate draft field layout against sealed source PDF POST /v1/esign/envelopes/{envelope_id}/void — Queue a sandbox signing-request cancellation; verify final state separately GET /v1/esign/providers — List eSignature providers and their actual availability GET /v1/esign/reports/export.csv — Export private signature request operational metadata as CSV GET /v1/esign/reports/summary — Private sandbox signature-request activity summary GET /v1/task-tools — List available PDF task operations and settings GET /v1/task-tools/{tool} — Describe a task operation and its accepted options GET /v1/tasks — List your document tasks POST /v1/tasks — Start a document task DELETE /v1/tasks/{task_id} — Discard a waiting task GET /v1/tasks/{task_id} — Retrieve task status GET /v1/tasks/{task_id}/download-url — Get a task's private output download URL POST /v1/tasks/{task_id}/files — Attach a verified upload to a waiting task POST /v1/tasks/{task_id}/process — Queue and meter a document task GET /v1/tasks/{task_id}/quote — Estimate HQ Credits for a waiting task from verified uploads POST /v1/tasks/{task_id}/uploads — Create an upload ticket for a task POST /v1/tasks/{task_id}/uploads/{upload_id}/complete — Seal an uploaded PDF and attach it to the task GET /v1/webhooks — List only this project's webhook subscriptions POST /v1/webhooks — Subscribe to project-scoped signed customer events GET /v1/webhooks/deliveries — Inspect scoped delivery statuses without confidential payloads POST /v1/webhooks/deliveries/{delivery_id}/replay — Replay dead delivery after correcting receiver DELETE /v1/webhooks/{subscription_id} — Revoke a project-scoped webhook subscription POST /v1/webhooks/{subscription_id}/rotate — Rotate secret; reveal replacement once POST /v1/webhooks/{subscription_id}/test — Enqueue one synthetic subscription test event GET /v1/workspace/documents — List documents POST /v1/workspace/documents — Register document DELETE /v1/workspace/documents/{document_id} — Remove document GET /v1/workspace/documents/{document_id} — Get document PATCH /v1/workspace/documents/{document_id} — Update document GET /v1/workspace/documents/{document_id}/activity — Document activity GET /v1/workspace/documents/{document_id}/handoff — Handoff options POST /v1/workspace/documents/{document_id}/handoff/ai — Handoff to ai POST /v1/workspace/documents/{document_id}/handoff/signing — Handoff to signing POST /v1/workspace/documents/{document_id}/handoff/task — Handoff to task GET /v1/workspace/documents/{document_id}/preview — Preview document GET /v1/workspace/documents/{document_id}/preview-url — Preview document url PUT /v1/workspace/documents/{document_id}/retention — Set retention Schema included Availability 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.
# 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.