For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GuidesAPI ReferenceChangelogModel Versioning
GuidesAPI ReferenceChangelogModel Versioning
    • Getting Started
    • Authentication
    • API Versioning
    • SDKs
    • Deployments
    • Error Codes
    • Async Processing
  • Endpoints
      • POSTSplit File (Sync)
      • POSTSplit File (Async)
      • GETGet Split Run
      • POSTCancel Split Run
      • DELDelete Split Run
      • GETList Split Runs
      • POSTCreate Splitter
      • GETGet Splitter
      • POSTUpdate Splitter
      • GETList Splitters
      • POSTCreate Splitter Version
      • GETGet Splitter Version
      • GETList Splitter Versions
  • Webhook Events
LogoLogo
EndpointsSplit

Get Split Run

GET
/split_runs/:id
GET
/split_runs/:id
1import { ExtendClient } from "extend-ai";
2
3const client = new ExtendClient({ token: "YOUR_TOKEN" });
4await client.splitRuns.retrieve("split_run_id_here");
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  },
36  "initialOutput": {
37    "splits": [
38      {
39        "type": "invoice",
40        "observation": "Pages 1-3 contain an invoice from Acme Corp",
41        "identifier": "INV-2024-001",
42        "startPage": 1,
43        "endPage": 3,
44        "classificationId": "invoice",
45        "id": "splt_xK9mLPqRtN3vS8wF5hB2cQ",
46        "fileId": "file_xK9mLPqRtN3vS8wF5hB2cQ",
47        "name": "string"
48      }
49    ],
50    "isExternal": true
51  },
52  "reviewedOutput": {
53    "splits": [
54      {
55        "type": "invoice",
56        "observation": "Pages 1-3 contain an invoice from Acme Corp",
57        "identifier": "INV-2024-001",
58        "startPage": 1,
59        "endPage": 3,
60        "classificationId": "invoice",
61        "id": "splt_xK9mLPqRtN3vS8wF5hB2cQ",
62        "fileId": "file_xK9mLPqRtN3vS8wF5hB2cQ",
63        "name": "string"
64      }
65    ],
66    "isExternal": true
67  },
68  "failureReason": "PARSING_ERROR",
69  "failureMessage": "string",
70  "metadata": {},
71  "reviewed": false,
72  "edited": false,
73  "config": {
74    "splitClassifications": [
75      {
76        "id": "my_unique_id",
77        "type": "invoice",
78        "description": "An invoice is a document that lists the items purchased and the total amount due.",
79        "identifierKey": "Extract the invoice number from the document header"
80      }
81    ],
82    "baseProcessor": "splitting_performance",
83    "baseVersion": "string",
84    "splitRules": "string",
85    "advancedOptions": {
86      "splitExcelDocumentsBySheetEnabled": false,
87      "pageRanges": [
88        {
89          "start": 1,
90          "end": 10
91        },
92        {
93          "start": 20,
94          "end": 30
95        }
96      ],
97      "pageOverlapEnabled": false,
98      "splitIdentifierRules": "string",
99      "splitMethod": "high_precision"
100    },
101    "parseConfig": {
102      "target": "markdown",
103      "chunkingStrategy": {
104        "type": "page",
105        "options": {
106          "minCharacters": 500,
107          "maxCharacters": 10000
108        }
109      },
110      "engine": "parse_performance",
111      "engineVersion": "latest",
112      "blockOptions": {
113        "figures": {
114          "enabled": true,
115          "figureImageClippingEnabled": true,
116          "advancedChartExtractionEnabled": false
117        },
118        "tables": {
119          "targetFormat": "html",
120          "tableHeaderContinuationEnabled": false,
121          "cellBlocksEnabled": false,
122          "agentic": {
123            "enabled": false,
124            "customInstructions": "string"
125          },
126          "enabled": true
127        },
128        "text": {
129          "signatureDetectionEnabled": false,
130          "agentic": {
131            "enabled": false,
132            "customInstructions": "string"
133          }
134        },
135        "keyValue": {
136          "blankFieldFormattingEnabled": false
137        },
138        "barcodes": {
139          "imageClippingEnabled": false,
140          "readingEnabled": false
141        },
142        "formulas": {
143          "enabled": false
144        }
145      },
146      "advancedOptions": {
147        "pageRotationEnabled": true,
148        "pageRanges": [
149          {
150            "start": 1,
151            "end": 10
152          },
153          {
154            "start": 20,
155            "end": 30
156          }
157        ],
158        "excelParsingMode": "basic",
159        "excelSkipHiddenContent": false,
160        "excelUseRawCellValues": false,
161        "excelSkipCalculation": true,
162        "verticalGroupingThreshold": 1,
163        "returnOcr": {
164          "words": false
165        },
166        "alwaysConvertToPdf": false,
167        "enrichmentFormat": "xml",
168        "imageConversionQuality": "medium",
169        "formattingDetection": [
170          {
171            "type": "change_tracking"
172          }
173        ]
174      }
175    }
176  },
177  "file": {
178    "object": "file",
179    "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
180    "name": "Invoices.pdf",
181    "type": "PDF",
182    "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
183    "metadata": {
184      "pageCount": 30,
185      "parentSplit": {
186        "id": "string",
187        "type": "Invoice",
188        "identifier": "other_2_9",
189        "startPage": 1,
190        "endPage": 10
191      }
192    },
193    "createdAt": "2024-03-21T16:45:00Z",
194    "updatedAt": "2024-03-21T16:45:00Z"
195  },
196  "parseRunId": "pr_Xj8mK2pL9nR4vT7qY5wZ",
197  "dashboardUrl": "https://dashboard.extend.ai/runs/splr_Xj8mK2pL9nR4vT7qY5wZ",
198  "usage": {
199    "credits": 9,
200    "totalCredits": 15,
201    "breakdown": [
202      {
203        "object": "parse_run",
204        "id": "pr_3UZSj69pYZDKHFuuX57ic",
205        "credits": 6
206      }
207    ]
208  },
209  "createdAt": "2024-03-21T16:45:00Z",
210  "updatedAt": "2024-03-21T16:45:00Z"
211}
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/developers/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.
Was this page helpful?
Previous

Cancel Split Run

Next
Built with

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.

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"Optional
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/developers/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](https://docs.extend.ai/2026-02-09/developers/authentication) for details on API key scopes.

Response

Successfully retrieved split run
objectenum

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

Allowed values:
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
Allowed values:
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
The file that was processed.
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

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.

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.