Extractors Migration

What You Get

Dedicated /extractors endpoints — No more type: "EXTRACT" filters, cleaner API surface
New GET /extractors/{id} endpoint — Retrieve a single extractor with its draft version (not available in old API)
Typed SDK responses — extractor objects are typed, no casting needed
Simpler config — No more type field required in config

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

Quick Start: Common Patterns

Creating an Extractor

TypeScript

Python

Java

Before (2025-04-21)

1 const processor = await client.processor.create({
2   name: "Invoice Extractor",
3   type: "EXTRACT",
4   config: { type: "EXTRACT", baseProcessor: "extraction_performance", schema: {...} }
5 });
6 console.log(processor.processor.id);

After (2026-02-09)

1 const extractor = await client.extractors.create({
2   name: "Invoice Extractor",
3   config: { baseProcessor: "extraction_performance", schema: {...} }
4 });
5 console.log(extractor.id);

Retrieving an Extractor (New!)

TypeScript

Python

Java

1 const extractor = await client.extractors.retrieve("ex_abc123");
2 console.log(extractor.draftVersion.config);

Listing Extractors

TypeScript

Python

Java

Before

1 const processors = await client.processor.list({ type: "EXTRACT" });

After

1 const extractors = await client.extractors.list();

Publishing a Version

TypeScript

Python

Java

Before

1 const version = await client.processorVersion.create("dp_abc123", { releaseType: "minor" });

After

1 const version = await client.extractorVersions.create("ex_abc123", { releaseType: "minor" });

Endpoint Changes Summary

Old Endpoint	New Endpoint
`POST /processors` (type: EXTRACT)	`POST /extractors`
`GET /processors?type=EXTRACT`	`GET /extractors`
(not available)	`GET /extractors/{id}` (new!)
`POST /processors/{id}`	`POST /extractors/{id}`
`POST /processors/{id}/publish`	`POST /extractors/{extractorId}/versions`
`GET /processors/{id}/versions`	`GET /extractors/{extractorId}/versions`
`GET /processors/{id}/versions/{versionId}`	`GET /extractors/{extractorId}/versions/{versionId}`

Request Changes

Creating an Extractor

Old	New	Notes
`type: "EXTRACT"`	(removed)	Implicit from endpoint
`cloneProcessorId`	`cloneExtractorId`	Renamed
`config.type: "EXTRACT"`	(removed)	Implicit from endpoint
`config.parser`	`config.parseConfig`	Renamed
`config.baseProcessor`	`config.baseProcessor`	No change (optional)
`config.schema`	`config.schema`	Now required
`config.fields`	(removed)	Use `schema` instead

cloneExtractorId and config are mutually exclusive. You can either clone an existing extractor or provide a config, but not both. The API will return a validation error if both are provided.

Example: Create Request

1 {
2   "name": "Invoice Extractor",
3   "type": "EXTRACT",
4   "config": {
5     "type": "EXTRACT",
6     "baseProcessor": "extraction_performance",
7     "schema": {
8       "type": "object",
9       "properties": {
10         "vendorName": { "type": ["string", "null"] }
11       }
12     },
13     "parser": { "target": "markdown" }
14   }
15 }

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
`{ "extractor": {...} }`	`{...}` (object returned directly)
`processors`	`extractors`
`processorVersion`	`extractorVersion`
`versions`	`extractorVersions`
`processor.type: "EXTRACT"`	(removed) — Implicit from endpoint
`draftVersion.processorId`	`draftVersion.extractorId`
`draftVersion.processorType`	(removed)
`draftVersion.processorName`	(removed)
`draftVersion.updatedAt`	(removed)
List includes `versions[]`	(removed) — Use versions endpoint

Example: Response

1 {
2   "success": true,
3   "processor": {
4     "object": "document_processor",
5     "id": "dp_abc123",
6     "name": "Invoice Extractor",
7     "type": "EXTRACT",
8     "draftVersion": {
9       "object": "document_processor_version",
10       "id": "dpv_xyz789",
11       "processorId": "dp_abc123",
12       "processorName": "Invoice Extractor",
13       "processorType": "EXTRACT",
14       "version": "draft",
15       "config": { ... },
16       "createdAt": "2024-03-21T15:30:00Z",
17       "updatedAt": "2024-03-21T16:45:00Z"
18     }
19   }
20 }

Versions Endpoint Changes

List Versions

The list endpoint now returns summaries without config. Use the get version endpoint for full details.

1 {
2   "versions": [
3     {
4       "id": "dpv_abc123",
5       "version": "1.0",
6       "config": { ... }  // Included
7     }
8   ]
9 }

SDK Method Reference

Old Method	New Method
`client.processor.create()`	`client.extractors.create()`
`client.processor.list()`	`client.extractors.list()`
`client.processor.update()`	`client.extractors.update()`
—	`client.extractors.retrieve()` (new!)
`client.processorVersion.create()`	`client.extractorVersions.create()`
`client.processorVersion.list()`	`client.extractorVersions.list()`
`client.processorVersion.get()`	`client.extractorVersions.retrieve()`

Detailed Schema Changes

Extractor Schema

Property	Old (Processor)	New (Extractor)	Change
`object`	`"document_processor"`	`"extractor"`	Value changed
`id`	Required `string`	Required `string`	No change
`name`	Required	Required	No change
`type`	Required `"EXTRACT"`	—	Removed
`draftVersion`	`ProcessorVersion`	`ExtractorVersion`	No change
`createdAt`	Required	Required	No change
`updatedAt`	Required	Required	No change

ExtractorSummary Schema (List Response)

Property	Old	New	Change
`object`	`"document_processor"`	`"extractor"`	Value changed
`type`	Required	—	Removed
`versions`	Required array	—	Removed

ExtractorVersion Schema

Property	Old (ProcessorVersion)	New (ExtractorVersion)	Change
`object`	`"document_processor_version"`	`"extractor_version"`	Value changed
`id`	Required `string`	Required `string`	No change
`processorId`	Required	—	Renamed to `extractorId`
`extractorId`	—	Required	New
`processorName`	Optional	—	Removed
`processorType`	Required	—	Removed
`version`	Required	Required	No change
`description`	Optional	Optional	No change
`config`	`ExtractionConfig`	`ExtractConfig`	No change
`createdAt`	Required	Required	No change
`updatedAt`	Required	—	Removed

ExtractConfig Schema

Property	Old (ExtractionConfig)	New (ExtractConfig)	Change
`type`	Required `"EXTRACT"`	—	Removed
`baseProcessor`	Optional	Optional	No change
`schema`	Optional	Required	Now required
`fields`	Optional (deprecated)	—	Removed
`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.