extend-ai 1.7.0 → 1.8.0

package/reference.md

@@ -1621,6 +1621,106 @@ Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.extractRuns.<a href="/src/api/resources/extractRuns/client/Client.ts">createBatch</a>({ ...params }) -> Extend.BatchRun</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```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"
+            }
+        }]
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Extend.ExtractRunsCreateBatchRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ExtractRunsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -2116,7 +2216,7 @@ Retrieve a specific version of an extractor in Extend
 <dd>
 
 ```typescript
-await client.extractorVersions.retrieve("extractor_id_here", "extractor_version_id_here");
+await client.extractorVersions.retrieve("extractor_id_here", "draft");
 
 ```
 </dd>
@@ -2146,9 +2246,12 @@ Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
 
 **versionId:** `string` 
 
-The ID of the specific extractor version.
+The version to retrieve. Accepts any of the following:
 
-Example: `"extv_QYk6jgHA_8CsO8rVWhyNC"`
+- `"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
     
 </dd>
 </dl>
@@ -2539,6 +2642,106 @@ Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.classifyRuns.<a href="/src/api/resources/classifyRuns/client/Client.ts">createBatch</a>({ ...params }) -> Extend.BatchRun</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```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"
+            }
+        }]
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Extend.ClassifyRunsCreateBatchRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ClassifyRunsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -3030,7 +3233,7 @@ Retrieve a specific version of a classifier in Extend
 <dd>
 
 ```typescript
-await client.classifierVersions.retrieve("classifier_id_here", "classifier_version_id_here");
+await client.classifierVersions.retrieve("classifier_id_here", "draft");
 
 ```
 </dd>
@@ -3060,9 +3263,12 @@ Example: `"cl_Xj8mK2pL9nR4vT7qY5wZ"`
 
 **versionId:** `string` 
 
-The ID of the specific classifier version.
+The version to retrieve. Accepts any of the following:
 
-Example: `"clsv_QYk6jgHA_8CsO8rVWhyNC"`
+- `"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
     
 </dd>
 </dl>
@@ -3453,6 +3659,107 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.splitRuns.<a href="/src/api/resources/splitRuns/client/Client.ts">createBatch</a>({ ...params }) -> Extend.BatchRun</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```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"
+            }
+        }]
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Extend.SplitRunsCreateBatchRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SplitRunsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -3946,7 +4253,7 @@ Retrieve a specific version of a splitter in Extend
 <dd>
 
 ```typescript
-await client.splitterVersions.retrieve("splitter_id_here", "splitter_version_id_here");
+await client.splitterVersions.retrieve("splitter_id_here", "draft");
 
 ```
 </dd>
@@ -3976,9 +4283,12 @@ Example: `"spl_Xj8mK2pL9nR4vT7qY5wZ"`
 
 **versionId:** `string` 
 
-The ID of the specific splitter version.
+The version to retrieve. Accepts any of the following:
 
-Example: `"splv_QYk6jgHA_8CsO8rVWhyNC"`
+- `"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
     
 </dd>
 </dl>
@@ -4439,11 +4749,6 @@ await client.workflowVersions.create("workflow_abc123");
 <dd>
 
 Get a specific version of a workflow, including its step definitions.
-
-The `versionId` parameter accepts:
-- `"draft"` — returns the current draft version
-- A version number (e.g. `"1"`, `"2"`) — returns that deployed version
-- An internal version ID (e.g. `"workflow_version_abc123"`) — returns that specific version
 </dd>
 </dl>
 </dd>
@@ -4482,7 +4787,14 @@ await client.workflowVersions.retrieve("workflow_abc123", "draft");
 <dl>
 <dd>
 
-**versionId:** `string` — The version to retrieve. Use `"draft"` for the draft, a number like `"1"` for a deployed version, or the internal version ID.
+**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
     
 </dd>
 </dl>
@@ -5938,6 +6250,89 @@ Example: `"bpr_Xj8mK2pL9nR4vT7qY5wZ"`
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## BatchRuns
+<details><summary><code>client.batchRuns.<a href="/src/api/resources/batchRuns/client/Client.ts">get</a>(id) -> Extend.BatchRun</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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 /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 processor type filtered by `batchId`:
+- `GET /extract_runs?batchId={id}`
+- `GET /classify_runs?batchId={id}`
+- `GET /split_runs?batchId={id}`
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.batchRuns.get("bpr_Xj8mK2pL9nR4vT7qY5wZ");
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` 
+
+The unique identifier of the batch processor run to retrieve.
+
+Example: `"bpr_Xj8mK2pL9nR4vT7qY5wZ"`
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `BatchRunsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>

package/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.7.0";
+export declare const SDK_VERSION = "1.8.0";

package/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "1.7.0";
+exports.SDK_VERSION = "1.8.0";

package/api/types/BatchProcessorRun.d.ts

@@ -1,66 +0,0 @@
-import type * as Extend from "../index";
-export interface BatchProcessorRun {
-    /** The type of response. In this case, it will always be `"batch_processor_run"`. */
-    object: string;
-    /**
-     * The unique identifier for this batch processor run.
-     *
-     * Example: `"batch_processor_run_Xj8mK2pL9nR4vT7qY5wZ"`
-     */
-    id: string;
-    /**
-     * The ID of the processor used for this run.
-     *
-     * Example: `"ex_Xj8mK2pL9nR4vT7qY5wZ"`
-     */
-    processorId: string;
-    /**
-     * The ID of the specific processor version used.
-     *
-     * Example: `"exv_xK9mLPqRtN3vS8wF5hB2cQ"`
-     */
-    processorVersionId: string;
-    /**
-     * The name of the processor.
-     *
-     * Example: `"Invoice Processor"`
-     */
-    processorName: string;
-    metrics: Extend.BatchProcessorRunMetrics;
-    /**
-     * The current status of the batch processor run:
-     * * `"PENDING"` - The batch processor run is waiting to start
-     * * `"PROCESSING"` - The batch processor run is in progress
-     * * `"PROCESSED"` - The batch processor run completed successfully
-     * * `"FAILED"` - The batch processor run encountered an error
-     */
-    status: Extend.BatchProcessorRunStatus;
-    /**
-     * The source of the batch processor run:
-     * * `"EVAL_SET"` - The batch processor run was made from an evaluation set. The `sourceId` will be the ID of the evaluation set (e.g., `"ev_1234"`)
-     * * `"PLAYGROUND"` - The batch processor run was made from the playground. The `sourceId` will not be set
-     * * `"STUDIO"` - The batch processor run was made for a processor in Studio. The `sourceId` will be the ID of the processor (e.g., `"ex_1234"`)
-     */
-    source: Extend.BatchProcessorRunSource;
-    /**
-     * The ID of the source of the batch processor run. See the `source` field for more details.
-     * Example: `"ev_1234"` for EVAL_SET source, `"ex_1234"` for STUDIO source
-     */
-    sourceId?: string;
-    /** The number of runs that were made. */
-    runCount: number;
-    /** The options for the batch processor run. */
-    options: Extend.BatchProcessorRunOptions;
-    /**
-     * The time (in UTC) at which the batch processor run was created. Will follow the RFC 3339 format.
-     *
-     * Example: `"2024-03-21T15:30:00Z"`
-     */
-    createdAt: string;
-    /**
-     * The time (in UTC) at which the batch processor run was last updated. Will follow the RFC 3339 format.
-     *
-     * Example: `"2024-03-21T16:45:00Z"`
-     */
-    updatedAt: string;
-}

package/api/types/BatchProcessorRunMetrics.d.ts

@@ -1,6 +0,0 @@
-export interface BatchProcessorRunMetrics {
-    /** The total number of files processed in this batch run */
-    numFiles?: number;
-    /** The total number of pages processed in this batch run */
-    numPages?: number;
-}

package/api/types/BatchProcessorRunOptions.d.ts

@@ -1,9 +0,0 @@
-/**
- * The options for the batch processor run.
- */
-export interface BatchProcessorRunOptions {
-    /** The fields that were fuzzy matched. */
-    fuzzyMatchFields?: string[];
-    /** The fields that were excluded from the run. */
-    excludeFields?: string[];
-}

package/api/types/BatchProcessorRunSource.d.ts

@@ -1,12 +0,0 @@
-/**
- * The source of the batch processor run:
- * * `"EVAL_SET"` - The batch processor run was made from an evaluation set. The `sourceId` will be the ID of the evaluation set (e.g., `"ev_1234"`)
- * * `"PLAYGROUND"` - The batch processor run was made from the playground. The `sourceId` will not be set
- * * `"STUDIO"` - The batch processor run was made for a processor in Studio. The `sourceId` will be the ID of the processor (e.g., `"ex_1234"`)
- */
-export declare const BatchProcessorRunSource: {
-    readonly EvalSet: "EVAL_SET";
-    readonly Playground: "PLAYGROUND";
-    readonly Studio: "STUDIO";
-};
-export type BatchProcessorRunSource = (typeof BatchProcessorRunSource)[keyof typeof BatchProcessorRunSource] | string;

package/api/types/BatchProcessorRunSource.js

@@ -1,15 +0,0 @@
-"use strict";
-// This file was auto-generated by Fern from our API Definition.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BatchProcessorRunSource = void 0;
-/**
- * The source of the batch processor run:
- * * `"EVAL_SET"` - The batch processor run was made from an evaluation set. The `sourceId` will be the ID of the evaluation set (e.g., `"ev_1234"`)
- * * `"PLAYGROUND"` - The batch processor run was made from the playground. The `sourceId` will not be set
- * * `"STUDIO"` - The batch processor run was made for a processor in Studio. The `sourceId` will be the ID of the processor (e.g., `"ex_1234"`)
- */
-exports.BatchProcessorRunSource = {
-    EvalSet: "EVAL_SET",
-    Playground: "PLAYGROUND",
-    Studio: "STUDIO",
-};

package/api/types/BatchProcessorRunStatus.d.ts

@@ -1,14 +0,0 @@
-/**
- * The current status of the batch processor run:
- * * `"PENDING"` - The batch processor run is waiting to start
- * * `"PROCESSING"` - The batch processor run is in progress
- * * `"PROCESSED"` - The batch processor run completed successfully
- * * `"FAILED"` - The batch processor run encountered an error
- */
-export declare const BatchProcessorRunStatus: {
-    readonly Pending: "PENDING";
-    readonly Processing: "PROCESSING";
-    readonly Processed: "PROCESSED";
-    readonly Failed: "FAILED";
-};
-export type BatchProcessorRunStatus = (typeof BatchProcessorRunStatus)[keyof typeof BatchProcessorRunStatus] | string;

package/api/types/BatchProcessorRunStatus.js

@@ -1,17 +0,0 @@
-"use strict";
-// This file was auto-generated by Fern from our API Definition.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BatchProcessorRunStatus = void 0;
-/**
- * The current status of the batch processor run:
- * * `"PENDING"` - The batch processor run is waiting to start
- * * `"PROCESSING"` - The batch processor run is in progress
- * * `"PROCESSED"` - The batch processor run completed successfully
- * * `"FAILED"` - The batch processor run encountered an error
- */
-exports.BatchProcessorRunStatus = {
-    Pending: "PENDING",
-    Processing: "PROCESSING",
-    Processed: "PROCESSED",
-    Failed: "FAILED",
-};

package/api/types/BatchRunEntity.d.ts

@@ -1,18 +0,0 @@
-import type * as Extend from "../index";
-/**
- * The extractor, classifier, or splitter that was run.
- *
- * **Availability:** Present when an entity was provided when creating the batch run.
- */
-export type BatchRunEntity = Extend.BatchRunEntity.Extractor | Extend.BatchRunEntity.Classifier | Extend.BatchRunEntity.Splitter;
-export declare namespace BatchRunEntity {
-    interface Extractor extends Extend.ExtractorSummary {
-        object: "extractor";
-    }
-    interface Classifier extends Extend.ClassifierSummary {
-        object: "classifier";
-    }
-    interface Splitter extends Extend.SplitterSummary {
-        object: "splitter";
-    }
-}