Create Split Job
Create a split job.
Document input
Set file_input to a file ID or a completed parse job ID (pjb-...). Supplying a parse job reuses its output instead of reading the document again.
Page selection
configuration.target_pages selects which pages of a supplied parse job to split (1-based; 1-50, 1,3,5-7). Pages are read in ascending document order, and each segment’s pages are the parse job’s own page numbers, so segments map straight back to the original document. Requires a parse job as file_input; passing it with a file ID returns 400.
Parse settings
configuration.parse_tier and configuration.parse_config_id control how the document is read before splitting; both are ignored when a parse job is supplied. A parse configuration restricted to a page subset (target_pages or max_pages) is rejected, since split results always number pages relative to the full document.
The job runs asynchronously. Poll GET /split/jobs/{split_job_id} or register a webhook to monitor completion.
Create Split Job
SplitCreateParams parameters = new()
{
FileInput = "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
};
var split = await client.Split.Create(parameters);
Console.WriteLine(split);{
"id": "id",
"categories": [
{
"name": "x",
"description": "x"
}
],
"document_input_type": "file_id",
"file_input": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"project_id": "project_id",
"status": "status",
"user_id": "user_id",
"configuration_id": "configuration_id",
"created_at": "2019-12-27T18:11:19.117Z",
"error_message": "error_message",
"parse_config_id": "parse_config_id",
"parse_tier": "parse_tier",
"result": {
"segments": [
{
"category": "category",
"confidence_category": "confidence_category",
"pages": [
0
]
}
]
},
"splitting_strategy": {
"allow_uncategorized": "forbid",
"custom_instructions": "Start a new segment at every signature page.",
"min_pages_per_split": 1
},
"target_pages": "target_pages",
"transaction_id": "transaction_id",
"updated_at": "2019-12-27T18:11:19.117Z"
}Returns Examples
{
"id": "id",
"categories": [
{
"name": "x",
"description": "x"
}
],
"document_input_type": "file_id",
"file_input": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"project_id": "project_id",
"status": "status",
"user_id": "user_id",
"configuration_id": "configuration_id",
"created_at": "2019-12-27T18:11:19.117Z",
"error_message": "error_message",
"parse_config_id": "parse_config_id",
"parse_tier": "parse_tier",
"result": {
"segments": [
{
"category": "category",
"confidence_category": "confidence_category",
"pages": [
0
]
}
]
},
"splitting_strategy": {
"allow_uncategorized": "forbid",
"custom_instructions": "Start a new segment at every signature page.",
"min_pages_per_split": 1
},
"target_pages": "target_pages",
"transaction_id": "transaction_id",
"updated_at": "2019-12-27T18:11:19.117Z"
}