Split Runs Migration

What You Get

Fully typed SDK responses — splitRun.output is typed, no more casting
Run without a splitter — Pass your split classifications inline with config
Cleaner request/response format — Simpler property names, predictable nullable fields
Better IDE experience — Autocomplete works out of the box

The old /processor_runs endpoint is still supported in this API version for backward compatibility. You can migrate incrementally.

Quick Start: Common Patterns

Running a Split

TypeScript

Python

Java

Before (2025-04-21)

1 const run = await client.processorRun.create({
2   processorId: "dp_abc123",
3   file: { fileUrl: "https://example.com/packet.pdf" },
4   sync: true
5 });
6 if (run.success) {
7   console.log(run.processorRun.output.splits);
8 }

After (2026-02-09)

1 const result = await client.split({
2   splitter: { id: "spl_abc123" },
3   file: { url: "https://example.com/packet.pdf" }
4 });
5 console.log(result.output?.splits);  // Typed!
6 
7 // Override a splitter's config (config moved inside splitter object)
8 const result = await client.split({
9   splitter: {
10     id: "spl_abc123",
11     overrideConfig: {
12       splitClassifications: [
13         { id: "invoice", name: "Invoice", description: "An invoice document" },
14         { id: "receipt", name: "Receipt", description: "A receipt document" }
15       ]
16     }
17   },
18   file: { url: "https://example.com/packet.pdf" }
19 });
20 
21 // Or with inline config (no splitter needed)
22 const result = await client.split({
23   config: {
24     splitClassifications: [
25       { id: "invoice", name: "Invoice", description: "An invoice document" },
26       { id: "receipt", name: "Receipt", description: "A receipt document" }
27     ]
28   },
29   file: { url: "https://example.com/packet.pdf" }
30 });

Listing Split Runs

TypeScript

Python

Java

Before

1 const runs = await client.processorRun.list({ processorType: "SPLITTER", processorId: "dp_abc123" });

After

1 const runs = await client.splitRuns.list({ splitterId: "spl_abc123" });

Endpoint Changes Summary

Old Endpoint	New Endpoint
`POST /processor_runs` (type: SPLITTER)	`POST /split_runs`
`GET /processor_runs?processorType=SPLITTER`	`GET /split_runs`
`GET /processor_runs/{id}`	`GET /split_runs/{id}`
`DELETE /processor_runs/{id}`	`DELETE /split_runs/{id}`
`POST /processor_runs/{id}/cancel`	`POST /split_runs/{id}/cancel`

Request Changes

File Properties

Old	New
`file.fileUrl`	`file.url`
`file.fileId`	`file.id`
`file.fileName`	`file.name`

Creating a Split Run

Old	New	Notes
`processorId`	`splitter.id`	Nested in object
`version`	`splitter.version`	Nested in object
`config` (with splitter)	`splitter.overrideConfig`	Moved inside splitter object. Top-level `config` is now only for inline splitting without a splitter
`sync: true`	(removed)	Use `POST /split` (sync, for testing), or `createAndPoll()` / webhooks for production
`config.type: "SPLITTER"`	(removed)	Implicit
`config.parser`	`parseConfig`	Renamed. Use `config.parseConfig` (inline) or `splitter.overrideConfig.parseConfig` (with splitter)

Breaking change: If you previously passed config alongside a processorId to override splitter settings, you must now pass it as splitter.overrideConfig inside the splitter object. The top-level config property is reserved for inline splitting (without a splitter).

Additionally, config.parser has been renamed to parseConfig everywhere — use config.parseConfig for inline config or splitter.overrideConfig.parseConfig when overriding a splitter.

Example: Overriding Splitter Config

If you previously passed config alongside processorId to override the splitter’s settings, this now moves inside the splitter object as overrideConfig:

1 {
2   "processorId": "dp_abc123",
3   "config": {
4     "splitClassifications": [
5       { "id": "invoice", "name": "Invoice", "description": "An invoice document" },
6       { "id": "receipt", "name": "Receipt", "description": "A receipt document" }
7     ],
8     "parser": { "type": "SIMPLE" }
9   },
10   "file": { "fileUrl": "https://example.com/packet.pdf" },
11   "sync": true
12 }

Response Changes

Response shape changes: Single object responses are now returned directly (no wrapper key), and list responses use { "object": "list", "data": [...] } format. See Simplified Response Shapes for details.

Old	New
`success: true`	(removed)
`{ "splitRun": {...} }`	`{...}` (object returned directly)
`processorRun.processorId`	`splitRun.splitter.id`
`processorRun.files[]`	`splitRun.file`
`processorRun.url`	`splitRun.dashboardUrl`
Optional fields	Required but nullable

Example: Response

1 {
2   "success": true,
3   "processorRun": {
4     "object": "document_processor_run",
5     "id": "dpr_abc123",
6     "processorId": "dp_xyz789",
7     "processorVersionId": "dpv_456",
8     "processorName": "Doc Splitter",
9     "type": "SPLITTER",
10     "status": "PROCESSED",
11     "output": {
12       "splits": [
13         {
14           "id": "invoice",
15           "type": "Invoice",
16           "fileId": "file_123",
17           "startPage": 1,
18           "endPage": 3
19         }
20       ]
21     },
22     "files": [{ "id": "file_456", "name": "packet.pdf" }],
23     "url": "https://dashboard.extend.ai/runs/dpr_abc123"
24   }
25 }

SDK Method Reference

Old Method	New Method
`client.processorRun.create()`	`client.splitRuns.create()`
`client.processorRun.get()`	`client.splitRuns.retrieve()`
`client.processorRun.list()`	`client.splitRuns.list()`
`client.processorRun.delete()`	`client.splitRuns.delete()`
`client.processorRun.cancel()`	`client.splitRuns.cancel()`
—	`client.split()` (new sync endpoint)
—	`client.splitRuns.createAndPoll()` (new)

Detailed Schema Changes

SplitRun Schema

Property	Old (ProcessorRun)	New (SplitRun)	Change
`object`	`"document_processor_run"`	`"split_run"`	Value changed
`id`	Required `string`	Required `string`	No change
`processorId`	Required	—	Removed, see `splitter.id`
`processorVersionId`	Required	—	Removed, see `splitterVersion.id`
`splitter`	—	Required `SplitterSummary \| null`	New
`splitterVersion`	—	Required `SplitterVersionSummary \| null`	New
`type`	Required `"SPLITTER"`	—	Removed (implicit)
`status`	Required	Required	No change
`output`	`SplitterOutput`	`SplitOutput \| null`	Now nullable
`initialOutput`	Optional	Required but nullable	Now required
`reviewedOutput`	Optional	Required but nullable	Now required
`failureReason`	Optional	Required but nullable	Now required
`config`	`SplitterConfig`	`SplitConfig`	No change
`files`	Required `File[]`	—	Removed
`file`	—	Required `FileSummary`	New
`url`	Required	—	Renamed
`dashboardUrl`	—	Required	New (replaces `url`)

SplitConfig Schema

Property	Old (SplitterConfig)	New (SplitConfig)	Change
`type`	Required `"SPLITTER"`	—	Removed
`baseProcessor`	Optional	Optional	No change
`splitClassifications`	Required	Required	No change
`parser`	Optional	—	Renamed
`parseConfig`	—	Optional	New (replaces `parser`)

Need Help?

If you encounter any issues while migrating, please contact our support team at support@extend.app.

Migration Guides

Guide	Migrating From	Migrating To
Overview	—	What’s new and how to upgrade
Extract Runs	`/processor_runs`	`/extract_runs` + `/extract`
Classify Runs	`/processor_runs`	`/classify_runs` + `/classify`
Split Runs	`/processor_runs`	`/split_runs` + `/split`
Parse Runs	`/parse`, `/parse/async`	`/parse_runs` + `/parse`
Edit Runs	`/edit`, `/edit/async`	`/edit_runs` + `/edit`
Extractors	`/processors`	`/extractors`
Classifiers	`/processors`	`/classifiers`
Splitters	`/processors`	`/splitters`
Files	`/files`	`/files` (breaking changes)
Evaluation Sets	evaluation endpoints	Updated evaluation endpoints
Workflow Runs	`/workflow_runs`	`/workflow_runs` (breaking changes)
Webhooks	`processor_run.*` events	`extract_run.`, `classify_run.`, etc.