Split Pages from PDF
Purpose
This API allows you to split a PDF into multiple documents.
Quick Reference
| Property | Value |
|---|---|
| Method | POST |
| Request URL | https://{zohoapis_domain}/pdfeditor/api/v1/pdf/pages/split |
Body Parameters
| Parameter | Value | Mandatory/Optional | Description |
|---|---|---|---|
| file | File or String | Mandatory | Upload the PDF file from your local drive or desktop. If the PDF is available via a publicly accessible web URL, you can provide the URL using the same parameter. |
| output_settings | { "name": "<document_name>" } | Mandatory | Specify the base name for the output PDF documents. |
| input_options | { "split_by": [5, 10] } | Mandatory | split_by – Specify the number of pages each output PDF document should contain. For example, a value of [5, 10] creates one document of 5 pages followed by one of 10 pages. |
Notes and Limits
- The maximum file size allowed for the input PDF is 50 MB.
- To use this API, an OAuth token should be generated with the following scopes: ZohoWriter.pdfEditor.ALL
Possible Errors
Refer to the following pages for the list of possible errors for this API:
Sample Request
Copiedcurl --location --request POST "https://www.zohoapis.com/pdfeditor/api/v1/pdf/pages/split" \
--header "Authorization: Zoho-oauthtoken xxx.yyy.zzz" \
--form 'files=@"/Users/username/Documents/Sample.pdf"' \
--form 'input_settings=“{\”split_by\”:\”2\"}"' \
--form 'output_settings=“{\”name\”:\”ModifiedFile.pdf\"}"'
Once the process begins, you will initially receive the 'status_url.' By invoking the 'status_url,' you will be able to monitor the status of the scheduled job.
Sample Response
Copied{
"status_check_url": "https://pdf.zoho.com/pdfeditor/api/v1/pdf/pages/split/job/f931a01183b33",
"status": inprogress
}Success Response
Copied{
"download_url" :"https://pdf.zoho.com/pdfeditor/api/v1/pdf/pages/split/download/{jobId}",
"status": "success"
}