Classify Runs Migration

What You Get

Fully typed SDK responses — classifyRun.output is typed, no more casting
Run without a classifier — Pass your 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 Classification

TypeScript

Python

Java

Before (2025-04-21)

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

After (2026-02-09)

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

Listing Classify Runs

TypeScript

Python

Java

Before

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

After

1 const runs = await client.classifyRuns.list({ classifierId: "cl_abc123" });

Endpoint Changes Summary

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

Request Changes

File Properties (All Endpoints)

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

Creating a Classify Run

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

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

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

Example: Create Request

1 {
2   "processorId": "dp_abc123",
3   "version": "latest",
4   "file": {
5     "fileUrl": "https://example.com/document.pdf",
6     "fileName": "document.pdf"
7   },
8   "sync": true
9 }

Example: Overriding Classifier Config

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

1 {
2   "processorId": "dp_abc123",
3   "config": {
4     "classifications": [
5       { "id": "invoice", "type": "invoice", "description": "An invoice" },
6       { "id": "receipt", "type": "receipt", "description": "A receipt" }
7     ],
8     "parser": { "type": "SIMPLE" }
9   },
10   "file": { "fileUrl": "https://example.com/document.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.

Key Differences

Old	New
`success: true`	(removed) — Use HTTP status codes
`{ "classifyRun": {...} }`	`{...}` (object returned directly)
`processorRun.processorId`	`classifyRun.classifier.id`
`processorRun.processorVersionId`	`classifyRun.classifierVersion.id`
`processorRun.files[]`	`classifyRun.file` (single object)
`processorRun.url`	`classifyRun.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 Classifier",
9     "type": "CLASSIFY",
10     "status": "PROCESSED",
11     "output": {
12       "id": "invoice",
13       "type": "invoice",
14       "confidence": 0.95
15     }
16   }
17 }

SDK Method Reference

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

Detailed Schema Changes

ClassifyRun Schema

Property	Old (ProcessorRun)	New (ClassifyRun)	Change
`object`	`"document_processor_run"`	`"classify_run"`	Value changed
`id`	Required `string`	Required `string`	No change
`processorId`	Required	—	Removed, see `classifier.id`
`processorVersionId`	Required	—	Removed, see `classifierVersion.id`
`classifier`	—	Required `ClassifierSummary \| null`	New
`classifierVersion`	—	Required `ClassifierVersionSummary \| null`	New
`type`	Required `"CLASSIFY"`	—	Removed
`output`	`ClassifierOutput`	`ClassifyOutput \| 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`	`ClassificationConfig`	`ClassifyConfig`	No change
`files`	Required array	—	Removed
`file`	—	Required `FileSummary`	New
`edits`	Required	—	Removed
`url`	Required	—	Renamed to `dashboardUrl`
`dashboardUrl`	—	Required	New

ClassifyConfig Schema

Property	Old (ClassificationConfig)	New (ClassifyConfig)	Change
`type`	Required `"CLASSIFY"`	—	Removed
`baseProcessor`	Optional	Optional	No change
`classifications`	Required	Required	No change
`parser`	Optional	—	Renamed
`parseConfig`	—	Optional	New

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.