- Break a multi-page PDF into page-range segments you define yourself, using a .
- Let Box interpret natural language instructions to determine how pages are grouped, using a .
Example use cases
Prerequisites
Before you start, follow the steps in the guide to create a platform app and generate an access token. You also need:- A source PDF already stored in Box.
- A destination folder in Box that your app can write to.
API version
All requests to Document Split endpoints must specify a valid API version by setting thebox-version header to 2026.0.
For more details, see .
Split types
Thesplit_type you send determines the rest of the request body.
A smart split consumes AI Units. Box consumes 1 AI Unit for every 4 pages processed.
How Document Split works
Document Split runs asynchronously in two steps:- Send a
POSTrequest to/2.0/document_splitsto create a split job. The response contains a job ID. - Send a
GETrequest to/2.0/document_splits/{document_split_id}with that ID to retrieve the status and the generated files.
Create a split job
The request body has the same shape for both split types. Only the contents ofsplit_input differ.
For a complete request example, see the or guide.
The response contains the ID of the split job:
Get the status and results of a split job
Use the job ID from thePOST response to retrieve the details of the split.
cURL
split_definition in the response shows the ranges Box derived from your prompt. Use it to confirm that the prompt produced the grouping you expected.
