Get Split Run

GET

/split_runs/:id

GET

/split_runs/:id

1 from extend_ai import Extend
2 
3 client = Extend(
4     token="YOUR_TOKEN_HERE",
5     extend_api_version="2026-02-09",
6 )
7 
8 client.split_runs.retrieve(
9     id="split_run_id_here",
10 )

1 {
2   "object": "split_run",
3   "id": "splr_Xj8mK2pL9nR4vT7qY5wZ",
4   "status": "PROCESSING",
5   "output": {
6     "splits": [
7       {
8         "type": "invoice",
9         "observation": "Pages 1-3 contain an invoice from Acme Corp",
10         "identifier": "INV-2024-001",
11         "startPage": 1,
12         "endPage": 3,
13         "classificationId": "invoice",
14         "id": "splt_xK9mLPqRtN3vS8wF5hB2cQ",
15         "fileId": "file_xK9mLPqRtN3vS8wF5hB2cQ",
16         "name": "string"
17       }
18     ],
19     "isExternal": true
20   },
21   "splitter": {
22     "object": "splitter",
23     "id": "spl_Xj8mK2pL9nR4vT7qY5wZ",
24     "name": "Invoice Packet Splitter",
25     "createdAt": "2024-03-21T16:45:00Z",
26     "updatedAt": "2024-03-21T16:45:00Z"
27   },
28   "splitterVersion": {
29     "object": "splitter_version",
30     "id": "splv_xK9mLPqRtN3vS8wF5hB2cQ",
31     "description": "Updated split rules for multi-invoice packets",
32     "version": "draft",
33     "splitterId": "spl_Xj8mK2pL9nR4vT7qY5wZ",
34     "createdAt": "2024-03-21T16:45:00Z",
35     "createdBy": {
36       "type": "user",
37       "email": "matt@extend.app"
38     }
39   },
40   "initialOutput": {
41     "splits": [
42       {
43         "type": "invoice",
44         "observation": "Pages 1-3 contain an invoice from Acme Corp",
45         "identifier": "INV-2024-001",
46         "startPage": 1,
47         "endPage": 3,
48         "classificationId": "invoice",
49         "id": "splt_xK9mLPqRtN3vS8wF5hB2cQ",
50         "fileId": "file_xK9mLPqRtN3vS8wF5hB2cQ",
51         "name": "string"
52       }
53     ],
54     "isExternal": true
55   },
56   "reviewedOutput": {
57     "splits": [
58       {
59         "type": "invoice",
60         "observation": "Pages 1-3 contain an invoice from Acme Corp",
61         "identifier": "INV-2024-001",
62         "startPage": 1,
63         "endPage": 3,
64         "classificationId": "invoice",
65         "id": "splt_xK9mLPqRtN3vS8wF5hB2cQ",
66         "fileId": "file_xK9mLPqRtN3vS8wF5hB2cQ",
67         "name": "string"
68       }
69     ],
70     "isExternal": true
71   },
72   "failureReason": "PARSING_ERROR",
73   "failureMessage": "string",
74   "metadata": {},
75   "reviewed": false,
76   "edited": false,
77   "config": {
78     "splitClassifications": [
79       {
80         "id": "my_unique_id",
81         "type": "invoice",
82         "description": "An invoice is a document that lists the items purchased and the total amount due.",
83         "identifierKey": "Extract the invoice number from the document header"
84       }
85     ],
86     "baseProcessor": "splitting_performance",
87     "baseVersion": "string",
88     "splitRules": "string",
89     "advancedOptions": {
90       "splitExcelDocumentsBySheetEnabled": false,
91       "pageRanges": [
92         {
93           "start": 1,
94           "end": 10
95         },
96         {
97           "start": 20,
98           "end": 30
99         }
100       ],
101       "pageOverlapEnabled": false,
102       "splitIdentifierRules": "string",
103       "splitMethod": "high_precision"
104     },
105     "parseConfig": {
106       "target": "markdown",
107       "chunkingStrategy": {
108         "type": "page",
109         "options": {
110           "minCharacters": 500,
111           "maxCharacters": 10000
112         }
113       },
114       "engine": "parse_performance",
115       "engineVersion": "latest",
116       "blockOptions": {
117         "figures": {
118           "enabled": true,
119           "figureImageClippingEnabled": true,
120           "advancedChartExtractionEnabled": false,
121           "customInstructions": "string"
122         },
123         "tables": {
124           "targetFormat": "html",
125           "tableHeaderContinuationEnabled": false,
126           "cellBlocksEnabled": false,
127           "agentic": {
128             "enabled": false,
129             "customInstructions": "string"
130           },
131           "enabled": true
132         },
133         "text": {
134           "signatureDetectionEnabled": false,
135           "agentic": {
136             "enabled": false,
137             "customInstructions": "string"
138           }
139         },
140         "keyValue": {
141           "blankFieldFormattingEnabled": false
142         },
143         "barcodes": {
144           "imageClippingEnabled": false,
145           "readingEnabled": false
146         },
147         "formulas": {
148           "enabled": false
149         }
150       },
151       "advancedOptions": {
152         "pageRotationEnabled": true,
153         "pageRanges": [
154           {
155             "start": 1,
156             "end": 10
157           },
158           {
159             "start": 20,
160             "end": 30
161           }
162         ],
163         "excelParsingMode": "basic",
164         "excelSkipHiddenContent": false,
165         "excelUseRawCellValues": false,
166         "excelSkipCalculation": true,
167         "excelIncludeCellMetadata": false,
168         "excelIncludeCellFormatting": false,
169         "verticalGroupingThreshold": 1,
170         "returnOcr": {
171           "words": false
172         },
173         "alwaysConvertToPdf": false,
174         "enrichmentFormat": "xml",
175         "imageConversionQuality": "medium",
176         "formattingDetection": [
177           {
178             "type": "change_tracking"
179           }
180         ]
181       }
182     }
183   },
184   "file": {
185     "object": "file",
186     "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
187     "name": "Invoices.pdf",
188     "type": "PDF",
189     "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
190     "metadata": {
191       "pageCount": 30,
192       "parentSplit": {
193         "id": "string",
194         "type": "Invoice",
195         "identifier": "other_2_9",
196         "startPage": 1,
197         "endPage": 10
198       }
199     },
200     "createdAt": "2024-03-21T16:45:00Z",
201     "updatedAt": "2024-03-21T16:45:00Z"
202   },
203   "parseRunId": "pr_Xj8mK2pL9nR4vT7qY5wZ",
204   "dashboardUrl": "https://dashboard.extend.ai/runs/splr_Xj8mK2pL9nR4vT7qY5wZ",
205   "usage": {
206     "credits": 9,
207     "totalCredits": 15,
208     "breakdown": [
209       {
210         "object": "parse_run",
211         "id": "pr_3UZSj69pYZDKHFuuX57ic",
212         "credits": 6,
213         "charges": [
214           {
215             "product": "extraction_performance",
216             "unit": "page",
217             "quantity": 10,
218             "credits": 30
219           },
220           {
221             "product": "review_agent",
222             "unit": "page",
223             "quantity": 10,
224             "credits": 10
225           },
226           {
227             "product": "agentic_text_correction",
228             "unit": "page",
229             "quantity": 3,
230             "credits": 3,
231             "pages": [
232               2,
233               4,
234               7
235             ]
236           }
237         ]
238       }
239     ]
240   },
241   "createdAt": "2024-03-21T16:45:00Z",
242   "updatedAt": "2024-03-21T16:45:00Z"
243 }

Retrieve details about a specific split run, including its status and outputs.

A common use case for this endpoint is to poll for the status and final output of a split run when using the Create Split Run endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.

Retrieve details about a specific split run, including its status and outputs. A common use case for this endpoint is to poll for the status and final output of a split run when using the [Create Split Run](https://docs.extend.ai/2026-02-09/api-reference/endpoints/split/create-split-run) endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

The unique identifier for this split run.

Example: "spl_Xj8mK2pL9nR4vT7qY5wZ"

Headers

x-extend-api-version"2026-02-09"OptionalDefaults to 2026-02-09

API version to use for the request. If you’re using an SDK, you can ignore this parameter. If you are not using an SDK and do not specify a version, you will either receive a 400 Bad Request or be set to a previous legacy version. See API Versioning for more details.

API version to use for the request. If you're using an SDK, you can ignore this parameter. If you are not using an SDK and do not specify a version, you will either receive a `400 Bad Request` or be set to a previous legacy version. See [API Versioning](https://docs.extend.ai/2026-02-09/api-reference/api-versioning) for more details.

x-extend-workspace-idstringOptional

The workspace ID to target. Required when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See Authentication for details on API key scopes.

The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/api-reference/authentication) for details on API key scopes.

Response

Successfully retrieved split run

objectenum

The type of object. Will always be `"split_run"`.

idstring

The unique identifier for this split run. Example: `"splr_Xj8mK2pL9nR4vT7qY5wZ"`

statusenum

The status of a processor run (extract, classify, or split):

"PENDING" - The run has been created and is waiting to be processed
"PROCESSING" - The run is in progress
"PROCESSED" - The run completed successfully
"FAILED" - The run failed
"CANCELLED" - The run was cancelled

outputobject or null

The final output, either reviewed or initial. **Availability:** Present when `status` is `"PROCESSED"`.

splitterobject or null

The splitter that was used for this run. **Availability:** Present when a splitter reference was provided. Not present when using inline `config`.

splitterVersionobject or null

The version of the splitter that was used for this run. **Availability:** Present when a splitter reference was provided. Not present when using inline `config`.

initialOutputobject or null

The initial output from the split run, before any review edits. **Availability:** Present when `reviewed` is `true`.

reviewedOutputobject or null

The output after human review. **Availability:** Present when `reviewed` is `true`.

failureReasonstring or null

The reason for failure. **Availability:** Present when `status` is `"FAILED"`. Possible values include: * `ABORTED` - The run was aborted by the user * `INTERNAL_ERROR` - An unexpected internal error occurred * `FAILED_TO_PROCESS_FILE` - Failed to process the file (e.g., OCR failure, file access issues) * `INVALID_PROCESSOR` - The processor configuration is invalid * `INVALID_CONFIGURATION` - The provided configuration is incompatible with the selected model * `PARSING_ERROR` - Failed to parse the splitting output * `PRE_PROCESSING_FAILURE` - An error occurred during preprocessing * `POST_PROCESSING_FAILURE` - An error occurred during postprocessing * `OUT_OF_CREDITS` - Insufficient credits to run the splitter **Note:** Additional failure reasons may be added in the future. Your integration should handle unknown values gracefully.

failureMessagestring or null

A detailed message about the failure. **Availability:** Present when `status` is `"FAILED"`.

metadatamap from strings to any or null

Any metadata that was provided when creating the split run. **Availability:** Present when metadata was provided during creation.

reviewedboolean

Indicates whether the run has been reviewed by a human.

editedboolean

Indicates whether the run results have been edited during review.

configobject

The configuration used for this split run.

fileobject or null

The file that was processed. `null` when the file could not be accessed or processed (for example a run that failed during file ingestion, or a multi-file batch run).

parseRunIdstring or null

The ID of the parse run that was used for this split run. **Availability:** Present when a parse run was created.

dashboardUrlstring

The URL to view the split run in the Extend dashboard.

usageobject or null

Usage credits consumed by this split run. **Availability:** Present when `status` is `"PROCESSED"`. Will not be returned for runs created before October 7, 2025 or for customers on legacy billing systems.

createdAtstringformat: "date-time"

The time (in UTC) at which the object was created. Will follow the RFC 3339 format. Example: `"2024-03-21T16:45:00Z"`

updatedAtstringformat: "date-time"

The time (in UTC) at which the object was last updated. Will follow the RFC 3339 format. Example: `"2024-03-21T16:45:00Z"`

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error