Skip to main content
POST
/
v1
/
pdf
/
split2
Split PDF by Text Search
curl --request POST \
  --url https://api.pdf.co/v1/pdf/split2 \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "url": "<string>",
  "searchstring": "<string>",
  "regexsearch": true,
  "excludekeypages": true,
  "casesensitive": true,
  "lang": "eng+deu",
  "inline": true,
  "name": "<string>",
  "async": true,
  "password": "<string>",
  "expiration": 60,
  "profiles": "<string>",
  "httpusername": "<string>",
  "httppassword": "<string>"
}'

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
url
string<uri>
default:https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-split/split_by_barcode.pdf
required

URL to the source file url attribute.

​
searchstring
string
default:[[barcode:qrcode,datamatrix /bytescout\.com/]]
required

The string to search.

​
regexsearch
boolean
default:false

Set to true to enable regular expression search for the searchString(s) parameter.

​
excludekeypages
boolean
default:true
​
casesensitive
boolean
default:true

Set to false to don't use case-sensitive search.

​
lang
string
default:eng

Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. see Language Support. You can also use 2 languages simultaneously like this: eng+deu (any combination).

Example:

"eng+deu"

​
inline
boolean
default:false

Set to true to return results inside the response. Otherwise, the endpoint will return a URL to the output file generated.

​
name
string
default:output-split-by-barcode

File name for generated output.

​
async
boolean
default:false

Set async to true for long processes to run in the background, API will then return a jobId which you can use with the Background Job Check endpoint. Also see Webhooks & Callbacks

​
password
string

Password for the PDF file.

​
expiration
number
default:60

Sets the expiration time for the output link, in minutes. After this period, generated output file(s) are automatically deleted from PDF.co Temporary Files Storage. The maximum allowed duration depends on your subscription plan. For permanent storage of input files (e.g., reusable images, PDF templates, documents), use PDF.co Built‑In Files Storage.

​
profiles
string

Profiles are used configure extra options for specific API endpoints and may be unique to an API. For more information, see Profiles and the documentation of each endpoint for profiles specific to it.

​
httpusername
string

HTTP auth user name if required to access source URL.

​
httppassword
string

HTTP auth password if required to access source URL.