Compress PDF API
Compress PDFs asynchronously with controlled size-versus-quality settings. Preserve the original input in private storage and fetch the processed artifact with an expiring URL.
Endpoint and task semantics#
Operation code: compress
Start this operation with POST /v1/tasks and the tool code shown above. Upload and attach source PDFs (or use task-scoped upload endpoints), then call POST /v1/tasks/{task_id}/process with operation settings.
Shrink scanned reports and email attachments before distribution.
Inputs: 1–12 verified PDF uploads, submitted in order.
Configuration and extra parameters#
| Setting | Type | Behaviour |
|---|---|---|
| compression_level | string enum | recommended, extreme or low; unknown values fail validation. Default: recommended. |
Options are validated by the API. Unknown settings and unsupported values return an error instead of being ignored.
Working request sequence#
Programming language: cURL
Choose a language · scroll horizontally for all 10 SDK languages
# Server-side API calls. Save the returned task_id.
curl -fsS -X POST 'https://api.pdfhq.io/v1/tasks' \
-H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
-d '{"tool":"compress"}'
# Upload and verify 1 PDF(s), then obtain and approve a credit quote:
curl -fsS 'https://api.pdfhq.io/v1/tasks/TASK_ID/quote' -H 'x-api-key: YOUR_API_KEY'
# ONLY after explicit customer approval:
test "$PDFHQ_APPROVE_QUOTE" = yes || { echo "Approval required" >&2; exit 1; }
curl -fsS -X POST 'https://api.pdfhq.io/v1/tasks/TASK_ID/process' \
-H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
-d '{"options":{"compression_level":"recommended"}}'
curl -fsS 'https://api.pdfhq.io/v1/tasks/TASK_ID' -H 'x-api-key: YOUR_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.
Generated downloadable packages cover the task workflow only. Full-service SDKs require a verified runtime OpenAPI specification; the Python, JavaScript and TypeScript task SDKs stream file uploads; the other languages require signed multipart uploads implemented by the caller.
The returned task ID is used for both status polling and retrieval. After the task succeeds, request a signed output URL rather than embedding a download secret.
Output and important details#
Output PDF or ZIP as selected by the underlying processing pipeline.
Compression is not a guarantee of a smaller output for every PDF. Check actual output size.
Errors, retries and billing