PDF Split
Related Knowledgebase-Explore Samples
Split PDF into multiple PDF files.
Available Methods
[POST] /pdf/split (split by page index)
url
required. URL to the source file. Supports links from Google Drive, Dropbox and from built-in PDF.co files storage. For uploading files via API please check Files Upload section. If you are randomly gettingToo Many Requests
orAccess Denied
error for your input url, please try to addcache:
to enable built-in url caching. You can also encrypt data for output files and decrypt data input files with user-controlled data encryption (uses strongAES
encryption with your own keys). Click here to learn more.httpusername
(optional) - http auth user name if required to access sourceurl
.httppassword
(optional) - http auth password if required to access sourceurl
.pages
(optional, default is all pages) - comma-separated indices of pages (or page ranges) that you want to use. The first page index is always1
. For example, if you have a 7 page document that you want split into 3 separate PDFs but different number of pages it would go like this:1, 2, 3-
or1, 2, 3-7
which will result in 1 PDF with page one, 1 PDF with page two and one PDF with the rest of the pages. You can also use inverted page numbers adding β!β before the number. E.g.!1
meansthe very last page
,2-!2
meansfrom the second to the penultimate page
,!2-
meanslast two pages
. SPECIAL CASES: You also can use a single asterisk*
symbol as a page range to split every page and extract every page into a separate new pdf. Parameter must be a String.encrypt
(legacy, now all files are stored at the encrypted cloud storage by default.async
optional. Runs processing asynchronously. Returns Use JobId that you may use with/job/check
to check state of the processing (possible states:working
,failed
,aborted
andsuccess
). Must be one of:true
,false
.inline
optional.false
by default. Inasync
mode makes to returnbody
with the content of the output json (with the links to the output).name
optional. name of the output file.expiration
(optional). Output link expiration in minutes. Default is60
(i.e. 60 minutes or 1 hour). After this delay generated output file(s) (if any) will be auto-removed from PDF.co temporary files storage. Max allowed expiration period depends on your current subscription plan. To store permanent input files (e.g. re-usable images, pdf, documents), please use PDF.co built-in Files Storage instead.profiles
optional. Must be a String. Use this param to set additional configuration for fine tuning and extra options. Explore PDF.co knowledgebase for profile examples.- Method: POST
- URL: /v1/pdf/split
Query parameters
No query parameters accepted.
Body payload
{
"url": "https://bytescout-com.s3.amazonaws.com/files/demo-files/cloud-api/pdf-split/sample.pdf",
"pages": "1-2,3-",
"inline": true,
"name": "result.pdf",
"async": false
}
Example responses
/pdf/split
{
"urls": [
"https://pdf-temp-files.s3.amazonaws.com/1e9a7f2c46834160903276716424382b/result_page1-2.pdf",
"https://pdf-temp-files.s3.amazonaws.com/c976b9f89a2e460786a3d5c0deeeef67/result_page3-4.pdf"
],
"pageCount": 4,
"error": false,
"status": 200,
"name": "result.pdf",
"remainingCredits": 98441
}
Code Snippet
CURL
curl --location --request POST 'https://api.pdf.co/v1/pdf/split' \
--header 'Content-Type: application/json' \
--header 'x-api-key: ' \
--data-raw '{
"url": "https://bytescout-com.s3.amazonaws.com/files/demo-files/cloud-api/pdf-split/sample.pdf",
"pages": "1-2,3-",
"inline": true,
"name": "result.pdf",
"async": false
}'
[POST] /pdf/split2 (split by text search)
url
required. URL to the source file. Supports links from Google Drive, Dropbox and from built-in PDF.co files storage. For uploading files via API please check Files Upload section. If you are randomly gettingToo Many Requests
orAccess Denied
error for your input url, please try to addcache:
to enable built-in url caching. You can also encrypt data for output files and decrypt data input files with user-controlled data encryption (uses strongAES
encryption with your own keys). Click here to learn more.httpusername
(optional) - http auth user name if required to access sourceurl
.httppassword
(optional) - http auth password if required to access sourceurl
.searchString
(required). Text to search for on pages. Must be a String.excludeKeyPages
(optional). Set totrue
if you want to exclude pages where text was found.false
by default.regexSearch
(optional). Set totrue
to enable regular expressions for search string.false
by default.caseSensitive
(optional). Set totrue
to enable case sensitive search.false
by default.lang
optional. Sets language for OCR (text from image) to use for scanned PDF, PNG, JPG documents input when extracting text. Default is βengβ. Other languages are also supported:deu
,spa
,chi_sim
,jpn
and many others (full list of supported OCR languages is here. You can also use 2 languages simultaneously like this:eng+deu
orjpn+kor
(any combination).encrypt
(legacy, now all files are stored at the encrypted cloud storage by default.async
optional. Runs processing asynchronously. Returns Use JobId that you may use with/job/check
to check state of the processing (possible states:working
,failed
,aborted
andsuccess
). Must be one of:true
,false
.inline
optional.false
by default. Inasync
mode makes to returnbody
with the content of the output json (with the links to the output).name
optional. name of the output file.expiration
(optional). Output link expiration in minutes. Default is60
(i.e. 60 minutes or 1 hour). After this delay generated output file(s) (if any) will be auto-removed from PDF.co temporary files storage. Max allowed expiration period depends on your current subscription plan. To store permanent input files (e.g. re-usable images, pdf, documents), please use PDF.co built-in Files Storage instead.profiles
optional. Must be a String. Use this param to set additional configuration for fine tuning and extra options. Explore PDF.co knowledgebase for profile examples.- Method: POST
- URL: /v1/pdf/split2
Query parameters
No query parameters accepted.
Body payload
{
"url": "https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-split/multiple-invoices.pdf",
"searchString": "invoice number",
"excludeKeyPages": false,
"regexSearch": false,
"caseSensitive": false,
"inline": true,
"name": "invoice-extracted",
"async": false
}
Example responses
/pdf/split2
{
"urls": [
"https://pdf-temp-files.s3.amazonaws.com/1e9a7f2c46834160903276716424382b/invoice-extracted_page1.pdf",
"https://pdf-temp-files.s3.amazonaws.com/c976b9f89a2e460786a3d5c0deeeef67/invoice-extracted_page2.pdf",
"https://pdf-temp-files.s3.amazonaws.com/c976b9f89a2e460786a3d5c0deeeef67/invoice-extracted_page3.pdf"
],
"pageCount": 3,
"error": false,
"status": 200,
"name": "invoice-extracted.pdf",
"remainingCredits": 98441
}
Code Snippet
CURL
curl --location --request POST 'https://api.pdf.co/v1/pdf/split2' \
--header 'Content-Type: application/json' \
--header 'x-api-key: ' \
--data-raw '{
"url": "https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-split/multiple-invoices.pdf",
"searchString": "invoice number",
"excludeKeyPages": false,
"regexSearch": false,
"caseSensitive": false,
"inline": true,
"name": "invoice-extracted",
"async": false
}'
Knowledgebase
Samples
- C# - Async file upload and async Split PDF
- C# - Async file upload and async Split PDF By Text
- C# - Split PDF By Text From Uploaded File
- C# - Split PDF By Text From URL
- C# - Split PDF By Text From URL Asynchronously
- C# - Split PDF From Uploaded File
- C# - Split PDF From URL
- C# - Split PDF From URL Asynchronously
- cURL - PDF Split
- cURL - PDF Split By Text
- GoogleAppScript - Split All PDF in Google Drive Folder
- Java - Split PDF By Text From Uploaded File
- Java - Split PDF By Text From URL
- Java - Split PDF From Uploaded File
- Java - Split PDF From URL
- JavaScript - Split PDF By Text From Uploaded File (Node.js)
- JavaScript - Split PDF By Text From Uploaded File (Node.js) - Async API
- JavaScript - Split PDF By Text From URL (Node.js)
- JavaScript - Split PDF By Text From URL (Node.js) - Async API
- JavaScript - Split PDF From Uploaded File (Node.js)
- JavaScript - Split PDF From Uploaded File (Node.js) - Async API
- JavaScript - Split PDF From URL (Node.js)
- JavaScript - Split PDF From URL (Node.js) - Async API
- PHP - Split PDF Asynchronously
- PHP - Split PDF By Text Asynchronously
- PHP - Split PDF By Text From Uploaded File
- PHP - Split PDF From Uploaded File
- PowerShell - Split PDF By Text From Uploaded File
- PowerShell - Split PDF By Text From URL
- PowerShell - Split PDF By Text From URL Asynchronously
- PowerShell - Split PDF From Uploaded File
- PowerShell - Split PDF From URL
- PowerShell - Split PDF From URL Asynchronously
- Python - Split PDF By Text From Uploaded File
- Python - Split PDF By Text From Uploaded File Asynchronously
- Python - Split PDF From Uploaded File
- Python - Split PDF From Uploaded File Asynchronously
- VB.NET - Async file upload and async Split PDF
- VB.NET - Async file upload and async Split PDF By Text
- VB.NET - Split PDF By Text From Uploaded File
- VB.NET - Split PDF By Text From URL
- VB.NET - Split PDF By Text From URL Asynchronously
- VB.NET - Split PDF From Uploaded File
- VB.NET - Split PDF From URL
- VB.NET - Split PDF From URL Asynchronously
Copyright © 2016 - 2022 PDF.co