Split PDF API
Split a PDF by page ranges, selected pages, or target part size. Each strategy has its own conditional settings.
Endpoint and task semantics#
Operation code: split
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.
Separate large packets into individual files for downstream review.
Inputs: Exactly one verified PDF upload.
Configuration and extra parameters#
| Setting | Type | Behaviour |
|---|---|---|
| typerequired | range | pages | size | Select exactly one splitting strategy. |
| ranges | string | When type=range; 1-based ranges such as 1-3,4-8. |
| pages | string | When type=pages, selected page numbers such as 1,4,7. |
| allPages | boolean | When type=pages, split every page. Default: false. |
| maxSize | number (MB) | Required when type=size; greater than 0 and at most 50 MB. |
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":"split"}'
# 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":{"type":"range","ranges":"1-3,4-8"}}'
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#
ZIP archive of the extracted PDF parts.
Page numbers are 1-based. Validate requested pages against the source document.
Errors, retries and billing