# Reference
client.parse({ ...params }) -> Extend.ParseRun
-
#### 📝 Description
-
-
Parse a file synchronously, waiting for the result before returning. This endpoint has a **5-minute timeout** — if processing takes longer, the request will fail.
**Note:** This endpoint is intended for onboarding and testing only. For production workloads, use `POST /parse_runs` with [polling or webhooks](https://docs.extend.ai/2026-02-09/developers/async-processing) instead, as it provides better reliability for large files and avoids timeout issues.
The Parse endpoint allows you to convert documents into structured, machine-readable formats with fine-grained control over the parsing process. This endpoint is ideal for extracting cleaned document content to be used as context for downstream processing, e.g. RAG pipelines, custom ingestion pipelines, embeddings classification, etc.
For more details, see the [Parse File guide](https://docs.extend.ai/2026-02-09/product/parsing/parse).
#### 🔌 Usage
-
-
```typescript
await client.parse({
file: {
url: "https://example.com/bank_statement.pdf",
name: "bank_statement.pdf"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.ParseRequest`
-
**requestOptions:** `ExtendClient.RequestOptions`
client.edit({ ...params }) -> Extend.EditRun
-
#### 📝 Description
-
-
Edit a file synchronously, waiting for the result before returning. This endpoint has a **5-minute timeout** — if processing takes longer, the request will fail.
**Note:** This endpoint is intended for onboarding and testing only. For production workloads, use `POST /edit_runs` with [polling or webhooks](https://docs.extend.ai/2026-02-09/developers/async-processing) instead, as it provides better reliability for large files and avoids timeout issues.
The Edit endpoint allows you to detect and fill form fields in PDF documents.
For more details, see the [Edit File guide](https://docs.extend.ai/2026-02-09/product/editing/edit).
#### 🔌 Usage
-
-
```typescript
await client.edit({
file: {
url: "https://example.com/form.pdf"
},
config: {
instructions: "Fill out the form with the provided data",
advancedOptions: {
flattenPdf: true
}
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.EditRequest`
-
**requestOptions:** `ExtendClient.RequestOptions`
client.extract({ ...params }) -> Extend.ExtractRun
-
#### 📝 Description
-
-
Extract structured data from a file synchronously, waiting for the result before returning. This endpoint has a **5-minute timeout** — if processing takes longer, the request will fail.
**Note:** This endpoint is intended for onboarding and testing only. For production workloads, use `POST /extract_runs` with [polling or webhooks](https://docs.extend.ai/2026-02-09/developers/async-processing) instead, as it provides better reliability for large files and avoids timeout issues.
The Extract endpoint allows you to extract structured data from files using an existing extractor or an inline configuration.
For more details, see the [Extract File guide](https://docs.extend.ai/2026-02-09/product/extraction/quick-start-5-minutes).
#### 🔌 Usage
-
-
```typescript
await client.extract({
config: {
schema: {
"type": "object",
"properties": {
"vendor_name": {
"type": "string",
"description": "The name of the vendor"
},
"invoice_number": {
"type": "string",
"description": "The invoice number"
},
"total_amount": {
"type": "number",
"description": "The total amount due"
}
}
}
},
file: {
url: "https://example.com/invoice.pdf"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.ExtractRequest`
-
**requestOptions:** `ExtendClient.RequestOptions`
client.classify({ ...params }) -> Extend.ClassifyRun
-
#### 📝 Description
-
-
Classify a document synchronously, waiting for the result before returning. This endpoint has a **5-minute timeout** — if processing takes longer, the request will fail.
**Note:** This endpoint is intended for onboarding and testing only. For production workloads, use `POST /classify_runs` with [polling or webhooks](https://docs.extend.ai/2026-02-09/developers/async-processing) instead, as it provides better reliability for large files and avoids timeout issues.
The Classify endpoint allows you to classify documents using an existing classifier or an inline configuration.
For more details, see the [Classify File guide](https://docs.extend.ai/2026-02-09/product/classification/configuring-a-classifier).
#### 🔌 Usage
-
-
```typescript
await client.classify({
config: {
classifications: [{
id: "invoice",
type: "invoice",
description: "An invoice or bill for goods or services"
}, {
id: "receipt",
type: "receipt",
description: "A receipt confirming payment"
}, {
id: "other",
type: "other",
description: "Any other document type"
}]
},
file: {
url: "https://example.com/document.pdf"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.ClassifyRequest`
-
**requestOptions:** `ExtendClient.RequestOptions`
client.split({ ...params }) -> Extend.SplitRun
-
#### 📝 Description
-
-
Split a document synchronously, waiting for the result before returning. This endpoint has a **5-minute timeout** — if processing takes longer, the request will fail.
**Note:** This endpoint is intended for onboarding and testing only. For production workloads, use `POST /split_runs` with [polling or webhooks](https://docs.extend.ai/2026-02-09/developers/async-processing) instead, as it provides better reliability for large files and avoids timeout issues.
The Split endpoint allows you to split documents into multiple parts using an existing splitter or an inline configuration.
For more details, see the [Split File guide](https://docs.extend.ai/2026-02-09/product/splitting/configuring-a-splitter).
#### 🔌 Usage
-
-
```typescript
await client.split({
config: {
splitClassifications: [{
id: "invoice",
type: "invoice",
description: "An invoice or bill for goods or services",
identifierKey: "invoice number from the document header"
}, {
id: "receipt",
type: "receipt",
description: "A receipt confirming payment",
identifierKey: "receipt number"
}, {
id: "other",
type: "other",
description: "Any other document type"
}]
},
file: {
url: "https://example.com/multi-document.pdf"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.SplitRequest`
-
**requestOptions:** `ExtendClient.RequestOptions`
client.files.list({ ...params }) -> Extend.FilesListResponse
-
#### 📝 Description
-
-
List files.
#### 🔌 Usage
-
-
```typescript
await client.files.list({
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.FilesListRequest`
-
**requestOptions:** `FilesClient.RequestOptions`
client.files.retrieve(id, { ...params }) -> Extend.File_
-
#### 📝 Description
-
-
Fetch a file by its ID.
#### 🔌 Usage
-
-
```typescript
await client.files.retrieve("file_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
ID for the file. It will always start with `"file_"`.
Example: `"file_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.FilesRetrieveRequest`
-
**requestOptions:** `FilesClient.RequestOptions`
client.files.delete(id, { ...params }) -> Extend.FilesDeleteResponse
-
#### 📝 Description
-
-
Delete a file and all associated data from Extend. This operation is permanent and cannot be undone.
This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.
#### 🔌 Usage
-
-
```typescript
await client.files.delete("file_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the file to delete.
Example: `"file_xK9mLPqRtN3vS8wF5hB2cQ"`
-
**request:** `Extend.FilesDeleteRequest`
-
**requestOptions:** `FilesClient.RequestOptions`
client.files.upload(file, { ...params }) -> Extend.File_
-
#### 📝 Description
-
-
Upload and create a new file in Extend.
This endpoint accepts file contents and registers them as a File in Extend, which can be used for [running workflows](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/create-workflow-run), [creating evaluation set items](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/evaluation/create-evaluation-set-item), [parsing](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/parse/parse-file), etc.
If an uploaded file is detected as a Word or PowerPoint document, it will be automatically converted to a PDF.
Supported file types can be found [here](https://docs.extend.ai/2026-02-09/product/general/supported-file-types).
This endpoint requires multipart form encoding. Most HTTP clients will handle this encoding automatically (see the examples).
#### 🔌 Usage
-
-
```typescript
await client.files.upload(createReadStream("path/to/file"), {});
```
#### ⚙️ Parameters
-
-
**file:** `File | fs.ReadStream | Blob`
-
**request:** `Extend.FilesUploadRequest`
-
**requestOptions:** `FilesClient.RequestOptions`
client.parseRuns.list({ ...params }) -> Extend.ParseRunsListResponse
-
#### 📝 Description
-
-
List parse runs, with optional filters for status, batch ID, source, and file name.
Returns a paginated list of parse runs. Use `GET /parse_runs/{id}` to retrieve the full result including output for a specific run.
#### 🔌 Usage
-
-
```typescript
await client.parseRuns.list({
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.ParseRunsListRequest`
-
**requestOptions:** `ParseRunsClient.RequestOptions`
client.parseRuns.create({ ...params }) -> Extend.ParseRun
-
#### 📝 Description
-
-
Parse files to get cleaned, chunked target content (e.g. markdown).
The Parse endpoint allows you to convert documents into structured, machine-readable formats with fine-grained control over the parsing process. This endpoint is ideal for extracting cleaned document content to be used as context for downstream processing, e.g. RAG pipelines, custom ingestion pipelines, embeddings classification, etc.
The request returns immediately with a `PROCESSING` status. Use webhooks or poll the Get Parse Run endpoint for results.
#### 🔌 Usage
-
-
```typescript
await client.parseRuns.create({
file: {
url: "https://example.com/bank_statement.pdf",
name: "bank_statement.pdf"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.ParseRunsCreateRequest`
-
**requestOptions:** `ParseRunsClient.RequestOptions`
client.parseRuns.retrieve(id, { ...params }) -> Extend.ParseRun
-
#### 📝 Description
-
-
Retrieve the status and results of a parse run.
Use this endpoint to get results for a parse run that has already completed, or to check on the status of a parse run initiated by the [Create Parse Run](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/parse/create-parse-run) endpoint.
#### 🔌 Usage
-
-
```typescript
await client.parseRuns.retrieve("parse_run_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The unique identifier for the parse run.
Example: `"pr_xK9mLPqRtN3vS8wF5hB2cQ"`
-
**request:** `Extend.ParseRunsRetrieveRequest`
-
**requestOptions:** `ParseRunsClient.RequestOptions`
client.parseRuns.delete(id, { ...params }) -> Extend.ParseRunsDeleteResponse
-
#### 📝 Description
-
-
Delete a parse run and all associated data from Extend. This operation is permanent and cannot be undone.
This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.
#### 🔌 Usage
-
-
```typescript
await client.parseRuns.delete("parse_run_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the parse run to delete.
Example: `"pr_xK9mLPqRtN3vS8wF5hB2cQ"`
-
**request:** `Extend.ParseRunsDeleteRequest`
-
**requestOptions:** `ParseRunsClient.RequestOptions`
client.parseRuns.createBatch({ ...params }) -> Extend.BatchRun
-
#### 📝 Description
-
-
Submit up to **1,000 files** for parsing in a single request. Each file is processed as an independent parse run using the same configuration.
Unlike the single [Parse File (Async)](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/parse/create-parse-run) endpoint, this batch endpoint accepts an `inputs` array and immediately returns a `BatchRun` object containing a batch `id` and a `PENDING` status. The individual runs are then queued and processed asynchronously.
**Monitoring results:**
- **Webhooks (recommended):** Subscribe to `batch_parse_run.processed` and `batch_parse_run.failed` events. The webhook payload indicates the batch has finished — fetch individual run results using `GET /parse_runs?batchId={id}`.
- **Polling:** Call `GET /batch_runs/{id}` to check the overall batch status, and use `GET /parse_runs?batchId={id}` to retrieve individual run results.
**Notes:**
- `inputs` must contain between 1 and 1,000 items.
- File input supports URLs, Extend file IDs, and raw text strings.
#### 🔌 Usage
-
-
```typescript
await client.parseRuns.createBatch({
inputs: [{
file: {
url: "https://example.com/document1.pdf"
},
metadata: {
"customerId": "cust_abc123"
}
}, {
file: {
url: "https://example.com/document2.pdf"
},
metadata: {
"customerId": "cust_def456"
}
}, {
file: {
text: "This is some raw text to parse."
},
metadata: {
"source": "manual-entry"
}
}]
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.ParseRunsCreateBatchRequest`
-
**requestOptions:** `ParseRunsClient.RequestOptions`
client.editRuns.create({ ...params }) -> Extend.EditRun
-
#### 📝 Description
-
-
Edit and manipulate PDF documents by detecting and filling form fields.
The Edit Runs endpoint allows you to convert and edit documents and get an edit run ID that can be used to check status and retrieve results with the Get Edit Run endpoint.
The request returns immediately with a `PROCESSING` status. Use webhooks or poll the Get Edit Run endpoint for results.
#### 🔌 Usage
-
-
```typescript
await client.editRuns.create({
file: {
url: "https://example.com/form.pdf"
},
config: {
instructions: "Fill out the form with the provided data",
advancedOptions: {
flattenPdf: true
}
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.EditRunsCreateRequest`
-
**requestOptions:** `EditRunsClient.RequestOptions`
client.editRuns.retrieve(id, { ...params }) -> Extend.EditRun
-
#### 📝 Description
-
-
Retrieve the status and results of an edit run.
Use this endpoint to get results for an edit run that has already completed, or to check on the status of an edit run initiated via the [Create Edit Run](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/edit/create-edit-run) endpoint.
#### 🔌 Usage
-
-
```typescript
await client.editRuns.retrieve("edit_run_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The unique identifier for the edit run.
Example: `"edr_xK9mLPqRtN3vS8wF5hB2cQ"`
-
**request:** `Extend.EditRunsRetrieveRequest`
-
**requestOptions:** `EditRunsClient.RequestOptions`
client.editRuns.delete(id, { ...params }) -> Extend.EditRunsDeleteResponse
-
#### 📝 Description
-
-
Delete an edit run and all associated data from Extend. This operation is permanent and cannot be undone.
This endpoint can be used if you'd like to manage data retention on your own rather than relying on automated data retention policies, or to make one-off deletions for your downstream customers.
#### 🔌 Usage
-
-
```typescript
await client.editRuns.delete("edit_run_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the edit run to delete.
Example: `"edr_xK9mLPqRtN3vS8wF5hB2cQ"`
-
**request:** `Extend.EditRunsDeleteRequest`
-
**requestOptions:** `EditRunsClient.RequestOptions`
client.editTemplates.retrieve(id, { ...params }) -> Extend.EditTemplate
-
#### 📝 Description
-
-
Retrieve a saved edit template by ID.
Use this endpoint to inspect the source file, default edit configuration, and optional schema generation configuration saved on an edit template. You can reuse the returned `config` with `POST /edit` or `POST /edit_runs`, and reuse `schemaConfig` with `POST /edit_schemas/generate`.
#### 🔌 Usage
-
-
```typescript
await client.editTemplates.retrieve("edit_template_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The unique identifier for the edit template.
Example: `"edt_xK9mLPqRtN3vS8wF5hB2cQ"`
-
**request:** `Extend.EditTemplatesRetrieveRequest`
-
**requestOptions:** `EditTemplatesClient.RequestOptions`
client.editSchemas.generate({ ...params }) -> Extend.EditSchemaGenerationResponse
-
#### 📝 Description
-
-
Detect fields in a PDF form and synchronously return an edit schema payload.
Use this endpoint when you want Extend to bootstrap an `EditRootJSON` schema from an existing form, optionally mapping an existing schema onto the detected fields.
This endpoint returns the generated schema directly. There are no schema generation run resources to poll or delete.
For more details, see the [Generate Edit Schema guide](https://docs.extend.ai/2026-02-09/product/editing/generate-edit-schema) and the [Edit File guide](https://docs.extend.ai/2026-02-09/product/editing/edit).
#### 🔌 Usage
-
-
```typescript
await client.editSchemas.generate({
file: {
url: "https://example.com/form.pdf"
},
config: {
instructions: "Detect the form fields and use human-readable field names.",
advancedOptions: {
radioEnumsEnabled: true
}
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.EditSchemasGenerateRequest`
-
**requestOptions:** `EditSchemasClient.RequestOptions`
client.extractRuns.list({ ...params }) -> Extend.ExtractRunsListResponse
-
#### 📝 Description
-
-
List all extract runs.
Returns a summary of each run. Use `GET /extract_runs/{id}` to retrieve the full object including `output` and `config`.
#### 🔌 Usage
-
-
```typescript
await client.extractRuns.list({
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.ExtractRunsListRequest`
-
**requestOptions:** `ExtractRunsClient.RequestOptions`
client.extractRuns.create({ ...params }) -> Extend.ExtractRun
-
#### 📝 Description
-
-
Extract structured data from a file using an existing extractor or an inline configuration.
The request returns immediately with a `PROCESSING` status. Use webhooks or poll the Get Extract Run endpoint for results.
#### 🔌 Usage
-
-
```typescript
await client.extractRuns.create({
extractor: {
id: "ex_1234567890"
},
file: {
url: "https://example.com/invoice.pdf"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.ExtractRunsCreateRequest`
-
**requestOptions:** `ExtractRunsClient.RequestOptions`
client.extractRuns.retrieve(id, { ...params }) -> Extend.ExtractRun
-
#### 📝 Description
-
-
Retrieve details about a specific extract run, including its status, outputs, and any edits made during review.
A common use case for this endpoint is to poll for the status and final output of an extract run when using the [Create Extract Run](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/extract/create-extract-run) endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.
#### 🔌 Usage
-
-
```typescript
await client.extractRuns.retrieve("extract_run_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The unique identifier for this extract run.
Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.ExtractRunsRetrieveRequest`
-
**requestOptions:** `ExtractRunsClient.RequestOptions`
client.extractRuns.delete(id, { ...params }) -> Extend.ExtractRunsDeleteResponse
-
#### 📝 Description
-
-
Delete an extract run and all associated data from Extend. This operation is permanent and cannot be undone.
This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.
#### 🔌 Usage
-
-
```typescript
await client.extractRuns.delete("id");
```
#### ⚙️ Parameters
-
-
**id:** `string` — The ID of the extract run.
-
**request:** `Extend.ExtractRunsDeleteRequest`
-
**requestOptions:** `ExtractRunsClient.RequestOptions`
client.extractRuns.cancel(id, { ...params }) -> Extend.ExtractRun
-
#### 📝 Description
-
-
Cancel an in-progress extract run.
Note: Only extract runs with a status of `"PROCESSING"` can be cancelled. Extractor runs that have already completed, failed, or been cancelled cannot be cancelled again.
#### 🔌 Usage
-
-
```typescript
await client.extractRuns.cancel("extract_run_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the extract run to cancel.
Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.ExtractRunsCancelRequest`
-
**requestOptions:** `ExtractRunsClient.RequestOptions`
client.extractRuns.createBatch({ ...params }) -> Extend.BatchRun
-
#### 📝 Description
-
-
Submit up to **1,000 files** for extraction in a single request. Each file is processed as an independent extract run using the same extractor and configuration.
Unlike the single [Extract File (Async)](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/extract/create-extract-run) endpoint, this batch endpoint accepts an `inputs` array and immediately returns a `BatchRun` object containing a batch `id` and a `PENDING` status. The individual runs are then queued and processed asynchronously.
**Monitoring results:**
- **Webhooks (recommended):** Subscribe to `batch_processor_run.processed` and `batch_processor_run.failed` events. The webhook payload indicates the batch has finished — fetch individual run results using `GET /extract_runs?batchId={id}`.
- **Polling:** Call `GET /batch_runs/{id}` to check the overall batch status, and use `GET /extract_runs` filtered by `batchId` to retrieve individual run results.
**Notes:**
- A processor reference (`extractor.id`) is required — inline `config` is not supported for batch requests.
- `inputs` must contain between 1 and 1,000 items.
- All inputs in a batch use the same extractor version and override config.
#### 🔌 Usage
-
-
```typescript
await client.extractRuns.createBatch({
extractor: {
id: "ex_xK9mLPqRtN3vS8wF5hB2cQ"
},
inputs: [{
file: {
url: "https://example.com/invoice1.pdf"
},
metadata: {
"customerId": "cust_abc123"
}
}, {
file: {
url: "https://example.com/invoice2.pdf"
},
metadata: {
"customerId": "cust_def456"
}
}, {
file: {
url: "https://example.com/invoice3.pdf"
},
metadata: {
"customerId": "cust_ghi789"
}
}]
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.ExtractRunsCreateBatchRequest`
-
**requestOptions:** `ExtractRunsClient.RequestOptions`
client.extractors.list({ ...params }) -> Extend.ExtractorsListResponse
-
#### 📝 Description
-
-
List all extractors.
Returns a summary of each extractor. Use `GET /extractors/{id}` to retrieve the full object including `draftVersion`.
#### 🔌 Usage
-
-
```typescript
await client.extractors.list({
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.ExtractorsListRequest`
-
**requestOptions:** `ExtractorsClient.RequestOptions`
client.extractors.create({ ...params }) -> Extend.Extractor
-
#### 📝 Description
-
-
Create a new extractor.
You can optionally provide a `generate` object to automatically generate an extraction schema from sample documents using AI. `generate` is mutually exclusive with `config` and `cloneExtractorId`.
#### 🔌 Usage
-
-
```typescript
await client.extractors.create({
name: "Invoice Extractor",
config: {
schema: {
"type": "object",
"properties": {
"vendor_name": {
"type": [
"string",
"null"
],
"description": "The name of the vendor"
},
"invoice_number": {
"type": [
"string",
"null"
],
"description": "The invoice number"
},
"total_amount": {
"type": [
"number",
"null"
],
"description": "The total amount due"
}
}
}
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.ExtractorsCreateRequest`
-
**requestOptions:** `ExtractorsClient.RequestOptions`
client.extractors.retrieve(id, { ...params }) -> Extend.Extractor
-
#### 📝 Description
-
-
Get details of an extractor.
#### 🔌 Usage
-
-
```typescript
await client.extractors.retrieve("extractor_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the extractor to get.
Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.ExtractorsRetrieveRequest`
-
**requestOptions:** `ExtractorsClient.RequestOptions`
client.extractors.update(id, { ...params }) -> Extend.Extractor
-
#### 📝 Description
-
-
Update an existing extractor.
#### 🔌 Usage
-
-
```typescript
await client.extractors.update("extractor_id_here", {
name: "Invoice Extractor v2"
});
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the extractor to update.
Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.ExtractorsUpdateRequest`
-
**requestOptions:** `ExtractorsClient.RequestOptions`
client.extractorVersions.list(extractorId, { ...params }) -> Extend.ExtractorVersionsListResponse
-
#### 📝 Description
-
-
This endpoint allows you to fetch all versions of a given extractor, including the current `draft` version.
Versions are returned in descending order of creation (newest first) with the `draft` version first. The `draft` version is the latest unpublished version of the extractor, which can be published to create a new version. It might not have any changes from the last published version.
#### 🔌 Usage
-
-
```typescript
await client.extractorVersions.list("extractor_id_here", {
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
});
```
#### ⚙️ Parameters
-
-
**extractorId:** `string`
The ID of the extractor.
Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.ExtractorVersionsListRequest`
-
**requestOptions:** `ExtractorVersionsClient.RequestOptions`
client.extractorVersions.create(extractorId, { ...params }) -> Extend.ExtractorVersion
-
#### 📝 Description
-
-
This endpoint allows you to publish a new version of an existing extractor. Publishing a new version creates a snapshot of the extractor's current configuration and makes it available for use in workflows.
Publishing a new version does not automatically update existing workflows using this extractor. You may need to manually update workflows to use the new version if desired.
#### 🔌 Usage
-
-
```typescript
await client.extractorVersions.create("extractor_id_here", {
releaseType: "minor",
description: "Updated extraction rules for better accuracy"
});
```
#### ⚙️ Parameters
-
-
**extractorId:** `string`
The ID of the extractor.
Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.ExtractorVersionsCreateRequest`
-
**requestOptions:** `ExtractorVersionsClient.RequestOptions`
client.extractorVersions.retrieve(extractorId, versionId, { ...params }) -> Extend.ExtractorVersion
-
#### 📝 Description
-
-
Retrieve a specific version of an extractor in Extend
#### 🔌 Usage
-
-
```typescript
await client.extractorVersions.retrieve("extractor_id_here", "draft");
```
#### ⚙️ Parameters
-
-
**extractorId:** `string`
The ID of the extractor.
Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
-
**versionId:** `string`
The version to retrieve. Accepts any of the following:
- `"draft"` — returns the current draft version
- `"latest"` — returns the latest published version (falls back to draft if none published)
- A version number (e.g. `"0.1"`, `"1.0"`) — returns that specific published version
- A version ID (e.g. `"extv_QYk6jgHA_8CsO8rVWhyNC"`) — returns that specific version by ID
-
**request:** `Extend.ExtractorVersionsRetrieveRequest`
-
**requestOptions:** `ExtractorVersionsClient.RequestOptions`
client.classifyRuns.list({ ...params }) -> Extend.ClassifyRunsListResponse
-
#### 📝 Description
-
-
List all classify runs.
Returns a summary of each run. Use `GET /classify_runs/{id}` to retrieve the full object including `output` and `config`.
#### 🔌 Usage
-
-
```typescript
await client.classifyRuns.list({
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.ClassifyRunsListRequest`
-
**requestOptions:** `ClassifyRunsClient.RequestOptions`
client.classifyRuns.create({ ...params }) -> Extend.ClassifyRun
-
#### 📝 Description
-
-
Classify a document using an existing classifier or an inline configuration.
The request returns immediately with a `PROCESSING` status. Use webhooks or poll the Get Classify Run endpoint for results.
#### 🔌 Usage
-
-
```typescript
await client.classifyRuns.create({
classifier: {
id: "cl_1234567890"
},
file: {
url: "https://example.com/document.pdf"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.ClassifyRunsCreateRequest`
-
**requestOptions:** `ClassifyRunsClient.RequestOptions`
client.classifyRuns.retrieve(id, { ...params }) -> Extend.ClassifyRun
-
#### 📝 Description
-
-
Retrieve details about a specific classify run, including its status and outputs.
A common use case for this endpoint is to poll for the status and final output of a classify run when using the [Create Classify Run](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/classify/create-classify-run) endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.
#### 🔌 Usage
-
-
```typescript
await client.classifyRuns.retrieve("classify_run_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The unique identifier for this classify run.
Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.ClassifyRunsRetrieveRequest`
-
**requestOptions:** `ClassifyRunsClient.RequestOptions`
client.classifyRuns.delete(id, { ...params }) -> Extend.ClassifyRunsDeleteResponse
-
#### 📝 Description
-
-
Delete a classify run and all associated data from Extend. This operation is permanent and cannot be undone.
This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.
#### 🔌 Usage
-
-
```typescript
await client.classifyRuns.delete("id");
```
#### ⚙️ Parameters
-
-
**id:** `string` — The ID of the classify run.
-
**request:** `Extend.ClassifyRunsDeleteRequest`
-
**requestOptions:** `ClassifyRunsClient.RequestOptions`
client.classifyRuns.cancel(id, { ...params }) -> Extend.ClassifyRun
-
#### 📝 Description
-
-
Cancel an in-progress classify run.
Note: Only classify runs with a status of `"PROCESSING"` can be cancelled. Classifier runs that have already completed, failed, or been cancelled cannot be cancelled again.
#### 🔌 Usage
-
-
```typescript
await client.classifyRuns.cancel("classify_run_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the classify run to cancel.
Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.ClassifyRunsCancelRequest`
-
**requestOptions:** `ClassifyRunsClient.RequestOptions`
client.classifyRuns.createBatch({ ...params }) -> Extend.BatchRun
-
#### 📝 Description
-
-
Submit up to **1,000 files** for classification in a single request. Each file is processed as an independent classify run using the same classifier and configuration.
Unlike the single [Classify File (Async)](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/classify/create-classify-run) endpoint, this batch endpoint accepts an `inputs` array and immediately returns a `BatchRun` object containing a batch `id` and a `PENDING` status. The individual runs are then queued and processed asynchronously.
**Monitoring results:**
- **Webhooks (recommended):** Subscribe to `batch_processor_run.processed` and `batch_processor_run.failed` events. The webhook payload indicates the batch has finished — fetch individual run results using `GET /classify_runs?batchId={id}`.
- **Polling:** Call `GET /batch_runs/{id}` to check the overall batch status, and use `GET /classify_runs` filtered by `batchId` to retrieve individual run results.
**Notes:**
- A processor reference (`classifier.id`) is required — inline `config` is not supported for batch requests.
- `inputs` must contain between 1 and 1,000 items.
- All inputs in a batch use the same classifier version and override config.
#### 🔌 Usage
-
-
```typescript
await client.classifyRuns.createBatch({
classifier: {
id: "cl_xK9mLPqRtN3vS8wF5hB2cQ"
},
inputs: [{
file: {
url: "https://example.com/document1.pdf"
},
metadata: {
"customerId": "cust_abc123"
}
}, {
file: {
url: "https://example.com/document2.pdf"
},
metadata: {
"customerId": "cust_def456"
}
}, {
file: {
url: "https://example.com/document3.pdf"
},
metadata: {
"customerId": "cust_ghi789"
}
}]
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.ClassifyRunsCreateBatchRequest`
-
**requestOptions:** `ClassifyRunsClient.RequestOptions`
client.classifiers.list({ ...params }) -> Extend.ClassifiersListResponse
-
#### 📝 Description
-
-
List all classifiers.
Returns a summary of each classifier. Use `GET /classifiers/{id}` to retrieve the full object including `draftVersion`.
#### 🔌 Usage
-
-
```typescript
await client.classifiers.list({
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.ClassifiersListRequest`
-
**requestOptions:** `ClassifiersClient.RequestOptions`
client.classifiers.create({ ...params }) -> Extend.Classifier
-
#### 📝 Description
-
-
Create a new classifier.
#### 🔌 Usage
-
-
```typescript
await client.classifiers.create({
name: "Document Classifier",
config: {
classifications: [{
id: "invoice",
type: "invoice",
description: "An invoice or bill for goods or services"
}, {
id: "receipt",
type: "receipt",
description: "A receipt confirming payment"
}, {
id: "other",
type: "other",
description: "Any other document type"
}]
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.ClassifiersCreateRequest`
-
**requestOptions:** `ClassifiersClient.RequestOptions`
client.classifiers.retrieve(id, { ...params }) -> Extend.Classifier
-
#### 📝 Description
-
-
Get details of a classifier.
#### 🔌 Usage
-
-
```typescript
await client.classifiers.retrieve("classifier_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the classifier to get.
Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.ClassifiersRetrieveRequest`
-
**requestOptions:** `ClassifiersClient.RequestOptions`
client.classifiers.update(id, { ...params }) -> Extend.Classifier
-
#### 📝 Description
-
-
Update an existing classifier.
#### 🔌 Usage
-
-
```typescript
await client.classifiers.update("classifier_id_here", {
name: "Document Classifier v2"
});
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the classifier to update.
Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.ClassifiersUpdateRequest`
-
**requestOptions:** `ClassifiersClient.RequestOptions`
client.classifierVersions.list(classifierId, { ...params }) -> Extend.ClassifierVersionsListResponse
-
#### 📝 Description
-
-
This endpoint allows you to fetch all versions of a given classifier, including the current `draft` version.
Versions are returned in descending order of creation (newest first) with the `draft` version first. The `draft` version is the latest unpublished version of the classifier, which can be published to create a new version. It might not have any changes from the last published version.
#### 🔌 Usage
-
-
```typescript
await client.classifierVersions.list("classifier_id_here", {
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
});
```
#### ⚙️ Parameters
-
-
**classifierId:** `string`
The ID of the classifier.
Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.ClassifierVersionsListRequest`
-
**requestOptions:** `ClassifierVersionsClient.RequestOptions`
client.classifierVersions.create(classifierId, { ...params }) -> Extend.ClassifierVersion
-
#### 📝 Description
-
-
This endpoint allows you to publish a new version of an existing classifier. Publishing a new version creates a snapshot of the classifier's current configuration and makes it available for use in workflows.
Publishing a new version does not automatically update existing workflows using this classifier. You may need to manually update workflows to use the new version if desired.
#### 🔌 Usage
-
-
```typescript
await client.classifierVersions.create("classifier_id_here", {
releaseType: "minor",
description: "Added new document classification type"
});
```
#### ⚙️ Parameters
-
-
**classifierId:** `string`
The ID of the classifier.
Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.ClassifierVersionsCreateRequest`
-
**requestOptions:** `ClassifierVersionsClient.RequestOptions`
client.classifierVersions.retrieve(classifierId, versionId, { ...params }) -> Extend.ClassifierVersion
-
#### 📝 Description
-
-
Retrieve a specific version of a classifier in Extend
#### 🔌 Usage
-
-
```typescript
await client.classifierVersions.retrieve("classifier_id_here", "draft");
```
#### ⚙️ Parameters
-
-
**classifierId:** `string`
The ID of the classifier.
Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
-
**versionId:** `string`
The version to retrieve. Accepts any of the following:
- `"draft"` — returns the current draft version
- `"latest"` — returns the latest published version (falls back to draft if none published)
- A version number (e.g. `"0.1"`, `"1.0"`) — returns that specific published version
- A version ID (e.g. `"clsv_QYk6jgHA_8CsO8rVWhyNC"`) — returns that specific version by ID
-
**request:** `Extend.ClassifierVersionsRetrieveRequest`
-
**requestOptions:** `ClassifierVersionsClient.RequestOptions`
client.splitRuns.list({ ...params }) -> Extend.SplitRunsListResponse
-
#### 📝 Description
-
-
List all split runs.
Returns a summary of each run. Use `GET /split_runs/{id}` to retrieve the full object including `output` and `config`.
#### 🔌 Usage
-
-
```typescript
await client.splitRuns.list({
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.SplitRunsListRequest`
-
**requestOptions:** `SplitRunsClient.RequestOptions`
client.splitRuns.create({ ...params }) -> Extend.SplitRun
-
#### 📝 Description
-
-
Split a document into multiple parts using an existing splitter or an inline configuration.
The request returns immediately with a `PROCESSING` status. Use webhooks or poll the Get Split Run endpoint for results.
#### 🔌 Usage
-
-
```typescript
await client.splitRuns.create({
splitter: {
id: "spl_1234567890"
},
file: {
url: "https://example.com/multi-document.pdf"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.SplitRunsCreateRequest`
-
**requestOptions:** `SplitRunsClient.RequestOptions`
client.splitRuns.retrieve(id, { ...params }) -> Extend.SplitRun
-
#### 📝 Description
-
-
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.
#### 🔌 Usage
-
-
```typescript
await client.splitRuns.retrieve("split_run_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The unique identifier for this split run.
Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.SplitRunsRetrieveRequest`
-
**requestOptions:** `SplitRunsClient.RequestOptions`
client.splitRuns.delete(id, { ...params }) -> Extend.SplitRunsDeleteResponse
-
#### 📝 Description
-
-
Delete a split run and all associated data from Extend. This operation is permanent and cannot be undone.
This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.
#### 🔌 Usage
-
-
```typescript
await client.splitRuns.delete("id");
```
#### ⚙️ Parameters
-
-
**id:** `string` — The ID of the split run.
-
**request:** `Extend.SplitRunsDeleteRequest`
-
**requestOptions:** `SplitRunsClient.RequestOptions`
client.splitRuns.cancel(id, { ...params }) -> Extend.SplitRun
-
#### 📝 Description
-
-
Cancel an in-progress split run.
Note: Only split runs with a status of `"PROCESSING"` can be cancelled. Splitter runs that have already completed, failed, or been cancelled cannot be cancelled again.
#### 🔌 Usage
-
-
```typescript
await client.splitRuns.cancel("split_run_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the split run to cancel.
Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.SplitRunsCancelRequest`
-
**requestOptions:** `SplitRunsClient.RequestOptions`
client.splitRuns.createBatch({ ...params }) -> Extend.BatchRun
-
#### 📝 Description
-
-
Submit up to **1,000 files** for splitting in a single request. Each file is processed as an independent split run using the same splitter and configuration.
Unlike the single [Split File (Async)](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/split/create-split-run) endpoint, this batch endpoint accepts an `inputs` array and immediately returns a `BatchRun` object containing a batch `id` and a `PENDING` status. The individual runs are then queued and processed asynchronously.
**Monitoring results:**
- **Webhooks (recommended):** Subscribe to `batch_processor_run.processed` and `batch_processor_run.failed` events. The webhook payload indicates the batch has finished — fetch individual run results using `GET /split_runs?batchId={id}`.
- **Polling:** Call `GET /batch_runs/{id}` to check the overall batch status, and use `GET /split_runs` filtered by `batchId` to retrieve individual run results.
**Notes:**
- A processor reference (`splitter.id`) is required — inline `config` is not supported for batch requests.
- `inputs` must contain between 1 and 1,000 items.
- All inputs in a batch use the same splitter version and override config.
- Raw text input (`FileFromText`) is not supported for split runs. Use a URL or file ID.
#### 🔌 Usage
-
-
```typescript
await client.splitRuns.createBatch({
splitter: {
id: "spl_xK9mLPqRtN3vS8wF5hB2cQ"
},
inputs: [{
file: {
url: "https://example.com/multi-doc1.pdf"
},
metadata: {
"customerId": "cust_abc123"
}
}, {
file: {
url: "https://example.com/multi-doc2.pdf"
},
metadata: {
"customerId": "cust_def456"
}
}, {
file: {
url: "https://example.com/multi-doc3.pdf"
},
metadata: {
"customerId": "cust_ghi789"
}
}]
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.SplitRunsCreateBatchRequest`
-
**requestOptions:** `SplitRunsClient.RequestOptions`
client.splitters.list({ ...params }) -> Extend.SplittersListResponse
-
#### 📝 Description
-
-
List all splitters.
Returns a summary of each splitter. Use `GET /splitters/{id}` to retrieve the full object including `draftVersion`.
#### 🔌 Usage
-
-
```typescript
await client.splitters.list({
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.SplittersListRequest`
-
**requestOptions:** `SplittersClient.RequestOptions`
client.splitters.create({ ...params }) -> Extend.Splitter
-
#### 📝 Description
-
-
Create a new splitter.
#### 🔌 Usage
-
-
```typescript
await client.splitters.create({
name: "Document Splitter",
config: {
splitClassifications: [{
id: "invoice",
type: "invoice",
description: "An invoice or bill for goods or services",
identifierKey: "invoice number from the document header"
}, {
id: "receipt",
type: "receipt",
description: "A receipt confirming payment",
identifierKey: "receipt number"
}, {
id: "other",
type: "other",
description: "Any other document type"
}]
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.SplittersCreateRequest`
-
**requestOptions:** `SplittersClient.RequestOptions`
client.splitters.retrieve(id, { ...params }) -> Extend.Splitter
-
#### 📝 Description
-
-
Get details of a splitter.
#### 🔌 Usage
-
-
```typescript
await client.splitters.retrieve("splitter_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the splitter to get.
Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.SplittersRetrieveRequest`
-
**requestOptions:** `SplittersClient.RequestOptions`
client.splitters.update(id, { ...params }) -> Extend.Splitter
-
#### 📝 Description
-
-
Update an existing splitter.
#### 🔌 Usage
-
-
```typescript
await client.splitters.update("splitter_id_here", {
name: "Document Splitter v2"
});
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the splitter to update.
Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.SplittersUpdateRequest`
-
**requestOptions:** `SplittersClient.RequestOptions`
client.splitterVersions.list(splitterId, { ...params }) -> Extend.SplitterVersionsListResponse
-
#### 📝 Description
-
-
This endpoint allows you to fetch all versions of a given splitter, including the current `draft` version.
Versions are returned in descending order of creation (newest first) with the `draft` version first. The `draft` version is the latest unpublished version of the splitter, which can be published to create a new version. It might not have any changes from the last published version.
#### 🔌 Usage
-
-
```typescript
await client.splitterVersions.list("splitter_id_here", {
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
});
```
#### ⚙️ Parameters
-
-
**splitterId:** `string`
The ID of the splitter.
Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.SplitterVersionsListRequest`
-
**requestOptions:** `SplitterVersionsClient.RequestOptions`
client.splitterVersions.create(splitterId, { ...params }) -> Extend.SplitterVersion
-
#### 📝 Description
-
-
This endpoint allows you to publish a new version of an existing splitter. Publishing a new version creates a snapshot of the splitter's current configuration and makes it available for use in workflows.
Publishing a new version does not automatically update existing workflows using this splitter. You may need to manually update workflows to use the new version if desired.
#### 🔌 Usage
-
-
```typescript
await client.splitterVersions.create("splitter_id_here", {
releaseType: "minor",
description: "Improved split boundary detection"
});
```
#### ⚙️ Parameters
-
-
**splitterId:** `string`
The ID of the splitter.
Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.SplitterVersionsCreateRequest`
-
**requestOptions:** `SplitterVersionsClient.RequestOptions`
client.splitterVersions.retrieve(splitterId, versionId, { ...params }) -> Extend.SplitterVersion
-
#### 📝 Description
-
-
Retrieve a specific version of a splitter in Extend
#### 🔌 Usage
-
-
```typescript
await client.splitterVersions.retrieve("splitter_id_here", "draft");
```
#### ⚙️ Parameters
-
-
**splitterId:** `string`
The ID of the splitter.
Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
-
**versionId:** `string`
The version to retrieve. Accepts any of the following:
- `"draft"` — returns the current draft version
- `"latest"` — returns the latest published version (falls back to draft if none published)
- A version number (e.g. `"0.1"`, `"1.0"`) — returns that specific published version
- A version ID (e.g. `"splv_QYk6jgHA_8CsO8rVWhyNC"`) — returns that specific version by ID
-
**request:** `Extend.SplitterVersionsRetrieveRequest`
-
**requestOptions:** `SplitterVersionsClient.RequestOptions`
client.workflows.list({ ...params }) -> Extend.WorkflowsListResponse
-
#### 📝 Description
-
-
List all workflows. Returns a paginated list of workflow summaries.
#### 🔌 Usage
-
-
```typescript
await client.workflows.list({
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.WorkflowsListRequest`
-
**requestOptions:** `WorkflowsClient.RequestOptions`
client.workflows.create({ ...params }) -> Extend.Workflow
-
#### 📝 Description
-
-
Create a new workflow. Optionally provide `steps` to define the workflow's step graph.
When `steps` is omitted, the workflow is created with default steps (`TRIGGER` → `PARSE`). When `steps` is provided, the step graph is validated and the draft version is populated with the given steps.
**Note:** The default steps may change in the future. If your integration depends on a specific step graph, provide `steps` explicitly.
#### 🔌 Usage
-
-
```typescript
await client.workflows.create({
name: "Invoice Processing"
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.WorkflowsCreateRequest`
-
**requestOptions:** `WorkflowsClient.RequestOptions`
client.workflows.retrieve(id) -> Extend.Workflow
-
#### 📝 Description
-
-
Get details of a workflow, including its draft version and steps.
#### 🔌 Usage
-
-
```typescript
await client.workflows.retrieve("workflow_abc123");
```
#### ⚙️ Parameters
-
-
**id:** `string` — The ID of the workflow.
-
**requestOptions:** `WorkflowsClient.RequestOptions`
client.workflows.update(id, { ...params }) -> Extend.Workflow
-
#### 📝 Description
-
-
Update a workflow's draft. You can update the name, the steps, or both.
When `steps` is provided, the draft version's steps are replaced with the new set. Steps with matching names from the previous draft preserve their internal identity.
#### 🔌 Usage
-
-
```typescript
await client.workflows.update("workflow_abc123", {
name: "Updated Invoice Processing"
});
```
#### ⚙️ Parameters
-
-
**id:** `string` — The ID of the workflow to update.
-
**request:** `Extend.WorkflowsUpdateRequest`
-
**requestOptions:** `WorkflowsClient.RequestOptions`
client.workflowVersions.list(id, { ...params }) -> Extend.WorkflowVersionsListResponse
-
#### 📝 Description
-
-
List all versions of a workflow, including the draft version. Returns a paginated list of version summaries.
#### 🔌 Usage
-
-
```typescript
await client.workflowVersions.list("workflow_abc123", {
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
});
```
#### ⚙️ Parameters
-
-
**id:** `string` — The ID of the workflow.
-
**request:** `Extend.WorkflowVersionsListRequest`
-
**requestOptions:** `WorkflowVersionsClient.RequestOptions`
client.workflowVersions.create(id, { ...params }) -> Extend.WorkflowVersion
-
#### 📝 Description
-
-
Deploy a new version of a workflow. The deployed version becomes available for running workflow runs.
When `steps` is omitted, the current draft is deployed as-is. When `steps` is provided, the given steps are deployed directly without modifying the draft.
#### 🔌 Usage
-
-
```typescript
await client.workflowVersions.create("workflow_abc123");
```
#### ⚙️ Parameters
-
-
**id:** `string` — The ID of the workflow to deploy.
-
**request:** `Extend.WorkflowVersionsCreateRequest`
-
**requestOptions:** `WorkflowVersionsClient.RequestOptions`
client.workflowVersions.retrieve(id, versionId) -> Extend.WorkflowVersion
-
#### 📝 Description
-
-
Get a specific version of a workflow, including its step definitions.
#### 🔌 Usage
-
-
```typescript
await client.workflowVersions.retrieve("workflow_abc123", "draft");
```
#### ⚙️ Parameters
-
-
**id:** `string` — The ID of the workflow.
-
**versionId:** `string`
The version to retrieve. Accepts any of the following:
- `"draft"` — returns the current draft version
- `"latest"` — returns the latest published version (falls back to draft if none published)
- A version number (e.g. `"1"`, `"2"`) — returns that specific published version
- A version ID (e.g. `"workflow_version_abc123"`) — returns that specific version by ID
-
**requestOptions:** `WorkflowVersionsClient.RequestOptions`
client.workflowRuns.list({ ...params }) -> Extend.WorkflowRunsListResponse
-
#### 📝 Description
-
-
List runs of a Workflow. Workflows are sequences of steps that process files and data in a specific order to achieve a desired outcome. A WorkflowRun represents a single execution of a workflow against a file.
#### 🔌 Usage
-
-
```typescript
await client.workflowRuns.list({
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.WorkflowRunsListRequest`
-
**requestOptions:** `WorkflowRunsClient.RequestOptions`
client.workflowRuns.create({ ...params }) -> Extend.WorkflowRun
-
#### 📝 Description
-
-
Run a workflow with a file. A workflow is a sequence of steps that process files and data in a specific order to achieve a desired outcome.
The request returns immediately with a `PROCESSING` status. Use webhooks or poll the Get Workflow Run endpoint for results.
#### 🔌 Usage
-
-
```typescript
await client.workflowRuns.create({
workflow: {
id: "wf_1234567890"
},
file: {
url: "https://example.com/invoice.pdf"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.WorkflowRunsCreateRequest`
-
**requestOptions:** `WorkflowRunsClient.RequestOptions`
client.workflowRuns.retrieve(id, { ...params }) -> Extend.WorkflowRun
-
#### 📝 Description
-
-
Once a workflow has been run, you can check the status and output of a specific WorkflowRun.
#### 🔌 Usage
-
-
```typescript
await client.workflowRuns.retrieve("workflow_run_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the workflow run.
Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
-
**request:** `Extend.WorkflowRunsRetrieveRequest`
-
**requestOptions:** `WorkflowRunsClient.RequestOptions`
client.workflowRuns.update(id, { ...params }) -> Extend.WorkflowRun
-
#### 📝 Description
-
-
You can update the name and metadata of an in progress WorkflowRun at any time using this endpoint.
#### 🔌 Usage
-
-
```typescript
await client.workflowRuns.update("workflow_run_id_here", {
name: "Invoice #12345",
metadata: {
"customerId": "cust_abc123",
"source": "email-inbox"
}
});
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the workflow run.
Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
-
**request:** `Extend.WorkflowRunsUpdateRequest`
-
**requestOptions:** `WorkflowRunsClient.RequestOptions`
client.workflowRuns.delete(id, { ...params }) -> Extend.WorkflowRunsDeleteResponse
-
#### 📝 Description
-
-
Delete a workflow run and all associated data from Extend. This operation is permanent and cannot be undone.
This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.
#### 🔌 Usage
-
-
```typescript
await client.workflowRuns.delete("workflow_run_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the workflow run.
Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
-
**request:** `Extend.WorkflowRunsDeleteRequest`
-
**requestOptions:** `WorkflowRunsClient.RequestOptions`
client.workflowRuns.cancel(id, { ...params }) -> Extend.WorkflowRun
-
#### 📝 Description
-
-
Cancel a running workflow run by its ID. This endpoint allows you to stop a workflow run that is currently in progress.
Note: Only workflow runs with a status of `PROCESSING` or `PENDING` can be cancelled. Workflow runs that are completed, failed, in review, rejected, or already cancelled cannot be cancelled.
#### 🔌 Usage
-
-
```typescript
await client.workflowRuns.cancel("workflow_run_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the workflow run.
Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
-
**request:** `Extend.WorkflowRunsCancelRequest`
-
**requestOptions:** `WorkflowRunsClient.RequestOptions`
client.workflowRuns.createBatch({ ...params }) -> Extend.WorkflowRunsCreateBatchResponse
-
#### 📝 Description
-
-
This endpoint allows you to efficiently initiate large batches of workflow runs in a single request (up to 1,000 in a single request, but you can queue up multiple batches in rapid succession). It accepts an array of inputs, each containing a file and metadata pair. The primary use case for this endpoint is for doing large bulk runs of >1000 files at a time that can process over the course of a few hours without needing to manage rate limits that would likely occur using the primary run endpoint.
Unlike the single [Run Workflow](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/create-workflow-run) endpoint which returns the details of the created workflow runs immediately, this batch endpoint returns a `batchId`.
Our recommended usage pattern is to integrate with [Webhooks](https://docs.extend.ai/2026-02-09/product/webhooks/configuration) for consuming results, using the `metadata` and `batchId` to match up results to the original inputs in your downstream systems. However, you can integrate in a polling mechanism by using a combination of the [List Workflow Runs](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/list-workflow-runs) endpoint to fetch all runs via a batch, and then [Get Workflow Run](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/get-workflow-run) to fetch the full outputs each run.
**Priority:** All workflow runs created through this batch endpoint are automatically assigned a priority of 90.
**Processing and Monitoring:**
Upon successful submission, the endpoint returns a `batchId`. The individual workflow runs are then queued for processing.
- **Monitoring:** Track the progress and consume results of individual runs using [Webhooks](https://docs.extend.ai/2026-02-09/product/webhooks/configuration). Subscribe to events like `workflow_run.completed`, `workflow_run.failed`, etc. The webhook payload for these events will include the corresponding `batchId` and the `metadata` you provided for each input.
- **Fetching Results:** You can also use the [List Workflow Runs](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/list-workflow-runs) endpoint and filter using the `batchId` query param.
#### 🔌 Usage
-
-
```typescript
await client.workflowRuns.createBatch({
workflow: {
id: "wf_1234567890"
},
inputs: [{
file: {
url: "https://example.com/invoice1.pdf"
},
metadata: {
"customerId": "cust_abc123"
}
}, {
file: {
url: "https://example.com/invoice2.pdf"
},
metadata: {
"customerId": "cust_def456"
}
}]
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.WorkflowRunsCreateBatchRequest`
-
**requestOptions:** `WorkflowRunsClient.RequestOptions`
client.processorRun.list({ ...params }) -> Extend.ProcessorRunListResponse
-
#### 📝 Description
-
-
List runs of a Processor. A ProcessorRun represents a single execution of a processor against a file.
#### 🔌 Usage
-
-
```typescript
await client.processorRun.list({
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.ProcessorRunListRequest`
-
**requestOptions:** `ProcessorRunClient.RequestOptions`
client.processorRun.create({ ...params }) -> Extend.ProcessorRunCreateResponse
-
#### 📝 Description
-
-
Run processors (extraction, classification, splitting, etc.) on a given document.
**Synchronous vs Asynchronous Processing:**
- **Asynchronous (default)**: Returns immediately with `PROCESSING` status. Use webhooks or polling to get results.
- **Synchronous**: Set `sync: true` to wait for completion and get final results in the response (5-minute timeout).
**For asynchronous processing:**
- You can [configure webhooks](https://docs.extend.ai/2026-02-09/product/webhooks/configuration) to receive notifications when a processor run is complete or failed.
- Or you can [poll the get endpoint](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/legacy/get-processor-run) for updates on the status of the processor run.
#### 🔌 Usage
-
-
```typescript
await client.processorRun.create({
processorId: "processor_id_here"
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.ProcessorRunCreateRequest`
-
**requestOptions:** `ProcessorRunClient.RequestOptions`
client.processorRun.get(id, { ...params }) -> Extend.ProcessorRunGetResponse
-
#### 📝 Description
-
-
Retrieve details about a specific processor run, including its status, outputs, and any edits made during review.
A common use case for this endpoint is to poll for the status and final output of an async processor run when using the [Run Processor](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/legacy/create-processor-run) endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.
#### 🔌 Usage
-
-
```typescript
await client.processorRun.get("processor_run_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The unique identifier for this processor run.
Example: `"exr_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.ProcessorRunGetRequest`
-
**requestOptions:** `ProcessorRunClient.RequestOptions`
client.processorRun.delete(id, { ...params }) -> Extend.ProcessorRunDeleteResponse
-
#### 📝 Description
-
-
Delete a processor run and all associated data from Extend. This operation is permanent and cannot be undone.
This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.
#### 🔌 Usage
-
-
```typescript
await client.processorRun.delete("processor_run_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the processor run to delete.
Example: `"exr_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.ProcessorRunDeleteRequest`
-
**requestOptions:** `ProcessorRunClient.RequestOptions`
client.processorRun.cancel(id, { ...params }) -> Extend.ProcessorRunCancelResponse
-
#### 📝 Description
-
-
Cancel a running processor run by its ID. This endpoint allows you to stop a processor run that is currently in progress.
Note: Only processor runs with a status of `"PROCESSING"` can be cancelled. Processor runs that have already completed, failed, or been cancelled cannot be cancelled again.
#### 🔌 Usage
-
-
```typescript
await client.processorRun.cancel("processor_run_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The unique identifier for the processor run to cancel.
Example: `"exr_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.ProcessorRunCancelRequest`
-
**requestOptions:** `ProcessorRunClient.RequestOptions`
client.processor.list({ ...params }) -> Extend.LegacyListProcessorsResponse
-
#### 📝 Description
-
-
List all processors in your organization
#### 🔌 Usage
-
-
```typescript
await client.processor.list();
```
#### ⚙️ Parameters
-
-
**request:** `Extend.ProcessorListRequest`
-
**requestOptions:** `ProcessorClient.RequestOptions`
client.processor.create({ ...params }) -> Extend.ProcessorCreateResponse
-
#### 📝 Description
-
-
Create a new processor in Extend, optionally cloning from an existing processor
#### 🔌 Usage
-
-
```typescript
await client.processor.create({
name: "My Processor Name",
type: "EXTRACT"
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.ProcessorCreateRequest`
-
**requestOptions:** `ProcessorClient.RequestOptions`
client.processor.update(id, { ...params }) -> Extend.ProcessorUpdateResponse
-
#### 📝 Description
-
-
Update an existing processor in Extend
#### 🔌 Usage
-
-
```typescript
await client.processor.update("processor_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the processor to update.
Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.ProcessorUpdateRequest`
-
**requestOptions:** `ProcessorClient.RequestOptions`
client.processorVersion.list(id, { ...params }) -> Extend.ProcessorVersionListResponse
-
#### 📝 Description
-
-
This endpoint allows you to fetch all versions of a given processor, including the current `draft` version.
Versions are typically returned in descending order of creation (newest first), but this should be confirmed in the actual implementation.
The `draft` version is the latest unpublished version of the processor, which can be published to create a new version. It might not have any changes from the last published version.
#### 🔌 Usage
-
-
```typescript
await client.processorVersion.list("processor_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the processor to retrieve versions for.
Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.ProcessorVersionListRequest`
-
**requestOptions:** `ProcessorVersionClient.RequestOptions`
client.processorVersion.create(id, { ...params }) -> Extend.ProcessorVersionCreateResponse
-
#### 📝 Description
-
-
This endpoint allows you to publish a new version of an existing processor. Publishing a new version creates a snapshot of the processor's current configuration and makes it available for use in workflows.
Publishing a new version does not automatically update existing workflows using this processor. You may need to manually update workflows to use the new version if desired.
#### 🔌 Usage
-
-
```typescript
await client.processorVersion.create("processor_id_here", {
releaseType: "major"
});
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the processor to publish a new version for.
Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.ProcessorVersionCreateRequest`
-
**requestOptions:** `ProcessorVersionClient.RequestOptions`
client.processorVersion.get(processorId, processorVersionId, { ...params }) -> Extend.ProcessorVersionGetResponse
-
#### 📝 Description
-
-
Retrieve a specific version of a processor in Extend
#### 🔌 Usage
-
-
```typescript
await client.processorVersion.get("processor_id_here", "processor_version_id_here");
```
#### ⚙️ Parameters
-
-
**processorId:** `string`
The ID of the processor.
Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
-
**processorVersionId:** `string`
The ID of the specific processor version to retrieve.
Example: `"exv_QYk6jgHA_8CsO8rVWhyNC"`
-
**request:** `Extend.ProcessorVersionGetRequest`
-
**requestOptions:** `ProcessorVersionClient.RequestOptions`
client.batchProcessorRun.get(id, { ...params }) -> Extend.BatchProcessorRunGetResponse
-
#### 📝 Description
-
-
Retrieve details about a batch processor run, including evaluation runs.
**Deprecated:** This endpoint is maintained for backwards compatibility only and will be replaced in a future API version. Use [Get Evaluation Set Run](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/evaluation/get-evaluation-set-run) for interacting with evaluation set runs.
#### 🔌 Usage
-
-
```typescript
await client.batchProcessorRun.get("bpr_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The unique identifier of the batch processor run to retrieve.
Example: `"bpr_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.BatchProcessorRunGetRequest`
-
**requestOptions:** `BatchProcessorRunClient.RequestOptions`
client.batchRuns.get(id) -> Extend.BatchRun
-
#### 📝 Description
-
-
Retrieve the status of a batch run by its ID. The `status` field reflects the aggregate state of the batch.
This is a unified endpoint that works for batches created via any of the batch submission endpoints (`POST /parse_runs/batch`, `POST /extract_runs/batch`, `POST /classify_runs/batch`, `POST /split_runs/batch`).
| Status | Meaning |
|---|---|
| `PENDING` | Queued, not yet started |
| `PROCESSING` | Runs are actively being processed |
| `PROCESSED` | All runs have completed |
| `FAILED` | The batch encountered a fatal error |
| `CANCELLED` | The batch was cancelled |
To retrieve individual run results, use the List endpoint for the relevant type filtered by `batchId`:
- `GET /parse_runs?batchId={id}`
- `GET /extract_runs?batchId={id}`
- `GET /classify_runs?batchId={id}`
- `GET /split_runs?batchId={id}`
#### 🔌 Usage
-
-
```typescript
await client.batchRuns.get("bpr_Xj8mK2pL9nR4vT7qY5wZ");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The unique identifier of the batch processor run to retrieve.
Example: `"bpr_Xj8mK2pL9nR4vT7qY5wZ"`
-
**requestOptions:** `BatchRunsClient.RequestOptions`
client.evaluationSets.list({ ...params }) -> Extend.EvaluationSetsListResponse
-
#### 📝 Description
-
-
List evaluation sets in your account.
#### 🔌 Usage
-
-
```typescript
await client.evaluationSets.list({
entityId: "entity_id_here",
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.EvaluationSetsListRequest`
-
**requestOptions:** `EvaluationSetsClient.RequestOptions`
client.evaluationSets.create({ ...params }) -> Extend.EvaluationSet
-
#### 📝 Description
-
-
Evaluation sets are collections of files and expected outputs that are used to evaluate the performance of a given extractor, classifier, or splitter. This endpoint will create a new evaluation set, which items can be added to using the [Create Evaluation Set Item](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/evaluation/create-evaluation-set-item) endpoint.
Note: It is not necessary to create an evaluation set via API. You can also create an evaluation set via the Extend dashboard and take the ID from there. To learn more about how to create evaluation sets, see the [Evaluation Sets](https://docs.extend.ai/2026-02-09/product/evaluation/overview) product page.
#### 🔌 Usage
-
-
```typescript
await client.evaluationSets.create({
name: "Invoice Processing Test Set",
description: "Q4 vendor invoices for accuracy testing",
entityId: "ex_1234567890"
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.EvaluationSetsCreateRequest`
-
**requestOptions:** `EvaluationSetsClient.RequestOptions`
client.evaluationSets.retrieve(id, { ...params }) -> Extend.EvaluationSet
-
#### 📝 Description
-
-
Retrieve a specific evaluation set by ID. This returns an evaluation set object, but does not include the items in the evaluation set. You can use the [List Evaluation Set Items](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/evaluation/list-evaluation-set-items) endpoint to get the items in an evaluation set.
#### 🔌 Usage
-
-
```typescript
await client.evaluationSets.retrieve("evaluation_set_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the evaluation set.
Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
-
**request:** `Extend.EvaluationSetsRetrieveRequest`
-
**requestOptions:** `EvaluationSetsClient.RequestOptions`
client.evaluationSetItems.list(evaluationSetId, { ...params }) -> Extend.EvaluationSetItemsListResponse
-
#### 📝 Description
-
-
List items in a specific evaluation set.
Returns a summary of each evaluation set item. Use the [Get Evaluation Set Item](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/evaluation/get-evaluation-set-item) endpoint to get the full details of an evaluation set item.
#### 🔌 Usage
-
-
```typescript
await client.evaluationSetItems.list("evaluation_set_id_here", {
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
});
```
#### ⚙️ Parameters
-
-
**evaluationSetId:** `string`
The ID of the evaluation set.
Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
-
**request:** `Extend.EvaluationSetItemsListRequest`
-
**requestOptions:** `EvaluationSetItemsClient.RequestOptions`
client.evaluationSetItems.create(evaluationSetId, { ...params }) -> Extend.EvaluationSetItemsCreateResponse
-
#### 📝 Description
-
-
Evaluation set items are the individual files and expected outputs that are used to evaluate the performance of a given extractor, classifier, or splitter in Extend. This endpoint will create new evaluation set items in Extend, which will be used during an evaluation run.
**Limit:** You can create up to 100 items at a time.
Learn more about how to create evaluation set items in the [Evaluation Sets](https://docs.extend.ai/2026-02-09/product/evaluation/overview) product page.
#### 🔌 Usage
-
-
```typescript
await client.evaluationSetItems.create("evaluation_set_id_here", {
items: [{
fileId: "file_xK9mLPqRtN3vS8wF5hB2cQ",
expectedOutput: {
value: {
"vendor_name": "Acme Corp",
"invoice_number": "INV-001",
"total_amount": 1500
}
}
}]
});
```
#### ⚙️ Parameters
-
-
**evaluationSetId:** `string`
The ID of the evaluation set.
Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
-
**request:** `Extend.EvaluationSetItemsCreateRequest`
-
**requestOptions:** `EvaluationSetItemsClient.RequestOptions`
client.evaluationSetItems.retrieve(evaluationSetId, itemId, { ...params }) -> Extend.EvaluationSetItem
-
#### 📝 Description
-
-
Get details of an evaluation set item.
#### 🔌 Usage
-
-
```typescript
await client.evaluationSetItems.retrieve("evaluation_set_id_here", "evaluation_set_item_id_here");
```
#### ⚙️ Parameters
-
-
**evaluationSetId:** `string`
The ID of the evaluation set.
Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
-
**itemId:** `string`
The ID of the evaluation set item.
Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
-
**request:** `Extend.EvaluationSetItemsRetrieveRequest`
-
**requestOptions:** `EvaluationSetItemsClient.RequestOptions`
client.evaluationSetItems.update(evaluationSetId, itemId, { ...params }) -> Extend.EvaluationSetItem
-
#### 📝 Description
-
-
If you need to change the expected output for a given evaluation set item, you can use this endpoint to update the item. This can be useful if you need to correct an error in the expected output or if the output of the extractor, classifier, or splitter has changed.
#### 🔌 Usage
-
-
```typescript
await client.evaluationSetItems.update("evaluation_set_id_here", "evaluation_set_item_id_here", {
expectedOutput: {
value: {
"vendor_name": "Acme Corp",
"invoice_number": "INV-001",
"total_amount": 1750
}
}
});
```
#### ⚙️ Parameters
-
-
**evaluationSetId:** `string`
The ID of the evaluation set.
Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
-
**itemId:** `string`
The ID of the evaluation set item.
Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
-
**request:** `Extend.EvaluationSetItemsUpdateRequest`
-
**requestOptions:** `EvaluationSetItemsClient.RequestOptions`
client.evaluationSetItems.delete(evaluationSetId, itemId, { ...params }) -> Extend.EvaluationSetItemsDeleteResponse
-
#### 📝 Description
-
-
Delete an evaluation set item.
#### 🔌 Usage
-
-
```typescript
await client.evaluationSetItems.delete("evaluation_set_id_here", "evaluation_set_item_id_here");
```
#### ⚙️ Parameters
-
-
**evaluationSetId:** `string`
The ID of the evaluation set.
Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
-
**itemId:** `string`
The ID of the evaluation set item.
Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
-
**request:** `Extend.EvaluationSetItemsDeleteRequest`
-
**requestOptions:** `EvaluationSetItemsClient.RequestOptions`
client.evaluationSetRuns.create({ ...params }) -> Extend.EvaluationSetRun
-
#### 📝 Description
-
-
Create and start an async evaluation set run. The response returns the evaluation set run object with its initial status; use `GET /evaluation_set_runs/{id}` to poll for completion.
Evaluation set runs are currently supported for document processor evaluation sets.
#### 🔌 Usage
-
-
```typescript
await client.evaluationSetRuns.create({
evaluationSetId: "ev_2LcgeY_mp2T5yPaEuq5Lw",
entity: {
id: "ex_Xj8mK2pL9nR4vT7qY5wZ",
version: "1.0"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.EvaluationSetRunsCreateRequest`
-
**requestOptions:** `EvaluationSetRunsClient.RequestOptions`
client.evaluationSetRuns.retrieve(id, { ...params }) -> Extend.EvaluationSetRun
-
#### 📝 Description
-
-
Get details of an evaluation set run.
#### 🔌 Usage
-
-
```typescript
await client.evaluationSetRuns.retrieve("evaluation_set_run_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the evaluation set run.
Example: `"evr_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.EvaluationSetRunsRetrieveRequest`
-
**requestOptions:** `EvaluationSetRunsClient.RequestOptions`
client.webhookEndpoints.list({ ...params }) -> Extend.WebhookEndpointsListResponse
-
#### 📝 Description
-
-
List all webhook endpoints.
#### 🔌 Usage
-
-
```typescript
await client.webhookEndpoints.list({
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.WebhookEndpointsListRequest`
-
**requestOptions:** `WebhookEndpointsClient.RequestOptions`
client.webhookEndpoints.create({ ...params }) -> Extend.WebhookEndpointCreate
-
#### 📝 Description
-
-
Create a new webhook endpoint. The response includes a `signingSecret` that is only returned once — store it securely for verifying webhook signatures.
The `enabledEvents` array specifies which global event types this endpoint should receive. Use the [Webhook Events](https://docs.extend.ai/2026-02-09/developers/api-reference/webhook-events) reference to see available event types.
To subscribe to events scoped to a specific resource (e.g., a single extractor or workflow), use [Create Webhook Subscription](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/webhook/create-webhook-subscription) after creating the endpoint.
#### 🔌 Usage
-
-
```typescript
await client.webhookEndpoints.create({
url: "https://example.com/webhooks",
name: "Production webhook",
enabledEvents: ["extract_run.processed", "workflow.created"],
apiVersion: "apiVersion"
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.WebhookEndpointsCreateRequest`
-
**requestOptions:** `WebhookEndpointsClient.RequestOptions`
client.webhookEndpoints.retrieve(id, { ...params }) -> Extend.WebhookEndpoint
-
#### 📝 Description
-
-
Retrieve a webhook endpoint by ID.
#### 🔌 Usage
-
-
```typescript
await client.webhookEndpoints.retrieve("webhook_endpoint_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the webhook endpoint.
Example: `"wh_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.WebhookEndpointsRetrieveRequest`
-
**requestOptions:** `WebhookEndpointsClient.RequestOptions`
client.webhookEndpoints.update(id, { ...params }) -> Extend.WebhookEndpoint
-
#### 📝 Description
-
-
Update a webhook endpoint. Only the fields you include in the request body will be updated; omitted fields remain unchanged.
The `apiVersion` of a webhook endpoint cannot be changed after creation.
#### 🔌 Usage
-
-
```typescript
await client.webhookEndpoints.update("webhook_endpoint_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the webhook endpoint to update.
Example: `"wh_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.WebhookEndpointsUpdateRequest`
-
**requestOptions:** `WebhookEndpointsClient.RequestOptions`
client.webhookEndpoints.delete(id, { ...params }) -> Extend.WebhookEndpointsDeleteResponse
-
#### 📝 Description
-
-
Delete a webhook endpoint and all of its subscriptions. This operation is permanent and cannot be undone.
#### 🔌 Usage
-
-
```typescript
await client.webhookEndpoints.delete("webhook_endpoint_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the webhook endpoint to delete.
Example: `"wh_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.WebhookEndpointsDeleteRequest`
-
**requestOptions:** `WebhookEndpointsClient.RequestOptions`
client.webhookSubscriptions.list({ ...params }) -> Extend.WebhookSubscriptionsListResponse
-
#### 📝 Description
-
-
List webhook subscriptions. You can filter by `webhookEndpointId` to see all subscriptions for a given endpoint, or by `resourceId` to see all subscriptions for a given resource.
#### 🔌 Usage
-
-
```typescript
await client.webhookSubscriptions.list({
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.WebhookSubscriptionsListRequest`
-
**requestOptions:** `WebhookSubscriptionsClient.RequestOptions`
client.webhookSubscriptions.create({ ...params }) -> Extend.WebhookSubscription
-
#### 📝 Description
-
-
Create a resource-scoped webhook subscription on an existing webhook endpoint.
Subscriptions let you receive events for a specific resource (e.g., a single extractor or workflow) rather than all resources of that type. The `enabledEvents` must be valid for the given `resourceType` and the endpoint's `apiVersion`.
If a subscription already exists for the same endpoint and resource, it will be updated with the new `enabledEvents` instead of creating a duplicate.
#### 🔌 Usage
-
-
```typescript
await client.webhookSubscriptions.create({
webhookEndpointId: "wh_Xj8mK2pL9nR4vT7qY5wZ",
resourceType: "extractor",
resourceId: "ex_Xj8mK2pL9nR4vT7qY5wZ",
enabledEvents: ["extract_run.processed", "extract_run.failed"]
});
```
#### ⚙️ Parameters
-
-
**request:** `Extend.WebhookSubscriptionsCreateRequest`
-
**requestOptions:** `WebhookSubscriptionsClient.RequestOptions`
client.webhookSubscriptions.retrieve(id, { ...params }) -> Extend.WebhookSubscription
-
#### 📝 Description
-
-
Retrieve a webhook subscription by ID.
#### 🔌 Usage
-
-
```typescript
await client.webhookSubscriptions.retrieve("webhook_subscription_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the webhook subscription.
Example: `"whes_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.WebhookSubscriptionsRetrieveRequest`
-
**requestOptions:** `WebhookSubscriptionsClient.RequestOptions`
client.webhookSubscriptions.update(id, { ...params }) -> Extend.WebhookSubscription
-
#### 📝 Description
-
-
Update the enabled events on a webhook subscription.
#### 🔌 Usage
-
-
```typescript
await client.webhookSubscriptions.update("webhook_subscription_id_here", {
enabledEvents: ["extract_run.processed"]
});
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the webhook subscription to update.
Example: `"whes_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.WebhookSubscriptionsUpdateRequest`
-
**requestOptions:** `WebhookSubscriptionsClient.RequestOptions`
client.webhookSubscriptions.delete(id, { ...params }) -> Extend.WebhookSubscriptionsDeleteResponse
-
#### 📝 Description
-
-
Delete a webhook subscription. This operation is permanent and cannot be undone.
#### 🔌 Usage
-
-
```typescript
await client.webhookSubscriptions.delete("webhook_subscription_id_here");
```
#### ⚙️ Parameters
-
-
**id:** `string`
The ID of the webhook subscription to delete.
Example: `"whes_Xj8mK2pL9nR4vT7qY5wZ"`
-
**request:** `Extend.WebhookSubscriptionsDeleteRequest`
-
**requestOptions:** `WebhookSubscriptionsClient.RequestOptions`