Split Pages from PDF
Purpose
This API allows you to split a PDF into multiple documents and either download the result or store it in Zoho WorkDrive.
Quick Reference
| Property | Value |
|---|---|
| Method | POST |
| Request URL (Download) | https://{zohoapis_domain}/pdfeditor/api/v1/pdf/pages/split |
| Request URL (Store) | https://{zohoapis_domain}/pdfeditor/api/v1/pdf/pages/split/store |
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. |
| input_options | { "split_by": [5, 10] } | Mandatory | Specify the number of pages each output PDF document should contain. |
| output_settings | { "name": "<document_name>" } | Mandatory for download variant | Specify output configuration for downloadable result. |
| output_settings | { "name": "<document_name>", "folder_id": "<folder_id>", "overwrite_existing_file": true | false } | Mandatory for store variant | name – Specify the base name for the output PDF documents. folder_id – Specify the ID of the WorkDrive folder in which to store the output files. overwrite_existing_file(optional) – Set to true to overwrite existing files with the same name in the folder. |
input_options Parameters
| Parameter | Data Type | Possible Values | Default Value |
|---|---|---|---|
| split_by | JSON Array | [2], [5, 10] | – |
output_settings (Download) Parameters
| Parameter | Data Type | Possible Values | Default Value |
|---|---|---|---|
| name | String | Base name for the output PDF documents | – |
output_settings (Store) Parameters
| Parameter | Data Type | Possible Values | Default Value |
|---|---|---|---|
| name | String | Base name for the output PDF documents | – |
| folder_id | String | ID of the WorkDrive folder in which to store the output files | – |
| overwrite_existing_file | Boolean | true, false | false |
Notes and Limits
- The maximum file size allowed for the input PDF is 50 MB, and the PDF cannot exceed 400 pages.
- split_by specifies how many pages each output document should contain.
- The store variant requires a Zoho WorkDrive account.
- To use the download variant, an OAuth token should be generated with the following scopes: ZohoWriter.pdfEditor.ALL
- To use the store variant, an OAuth token should be generated with the following scopes: ZohoWriter.pdfEditor.ALL, WorkDrive.files.ALL, WorkDrive.organization.ALL
Possible Errors
Refer to the following pages for the list of possible errors for this API:
Download Variant 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.
Store Variant 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.
Download Variant Sample Response
Copied{
"status_check_url": "https://pdf.zoho.com/pdfeditor/api/v1/pdf/pages/split/job/f931a01183b33",
"status": inprogress
}Download Variant Success Response
Copied{
"download_url" :"https://pdf.zoho.com/pdfeditor/api/v1/pdf/pages/split/download/{jobId}",
"status": "success"
}Store Variant Sample Response
Copied{
"download_url" :"https://pdf.zoho.com/pdfeditor/api/v1/pdf/pages/split/download/{jobId}",
"status": "success"
}Store Variant Success Response
Copied{
"documents" : [
{
"name" : "file_name_1",
"document_url" : "https://{workdrive_service_url}/file/{resource_id}",
"document_id" : "{resource_id}"
},
{
"name" : "file_name_2",
"document_url" : "https://{workdrive_service_url}/file/{resource_id}",
"document_id" : "{resource_id}"
},
{
"name" : "file_name_3",
"error_code" : "R9006",
"error_message" : "Unable to upload document to WorkDrive"
}, .
.
.
{
"name" : "file_name_n",
"document_url" : "https://{workdrive_service_url}/file/{resource_id}",
"document_id" : "{resource_id}"
}
],
"status_check_url" : "https://pdf.zoho.com/pdfeditor/api/v1/pdf/pages/split/job/{jobId}",
"status": inprogress
}Store Variant Partial Success Response
Copied{
"documents" :
{
"name" : "file_name_1",
"document_url" : "https://{workdrive_service_url}/file/{resource_id}",
"document_id" : "{resource_id}"
},
{
"name" : "file_name_2",
"document_url" : "https://{workdrive_service_url}/file/{resource_id}",
"document_id" : "{resource_id}"
},
{
"name" : "file_name_3",
"document_url" : "https://{workdrive_service_url}/file/{resource_id}",
"document_id" : "{resource_id}"
},
.
.
.
{
"name" : "file_name_n",
"document_url" : "https://{workdrive_service_url}/file/{resource_id}",
"document_id" : "{resource_id}"
}
]
"status": "success"
}