extend-ai 1.2.0 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/BaseClient.js +2 -2
- package/Client.d.ts +72 -8
- package/Client.js +80 -12
- package/api/client/requests/ClassifyRequest.d.ts +16 -1
- package/api/client/requests/EditRequest.d.ts +7 -1
- package/api/client/requests/ExtractRequest.d.ts +20 -1
- package/api/client/requests/ParseRequest.d.ts +2 -1
- package/api/client/requests/SplitRequest.d.ts +18 -1
- package/api/resources/batchProcessorRun/client/Client.d.ts +1 -1
- package/api/resources/batchProcessorRun/client/Client.js +1 -1
- package/api/resources/classifierVersions/client/Client.d.ts +2 -1
- package/api/resources/classifierVersions/client/Client.js +2 -1
- package/api/resources/classifierVersions/client/requests/ClassifierVersionsCreateRequest.d.ts +2 -1
- package/api/resources/classifiers/client/Client.d.ts +19 -2
- package/api/resources/classifiers/client/Client.js +19 -2
- package/api/resources/classifiers/client/requests/ClassifiersCreateRequest.d.ts +16 -1
- package/api/resources/classifiers/client/requests/ClassifiersUpdateRequest.d.ts +3 -1
- package/api/resources/classifyRuns/client/Client.d.ts +4 -1
- package/api/resources/classifyRuns/client/Client.js +4 -1
- package/api/resources/classifyRuns/client/requests/ClassifyRunsCreateRequest.d.ts +4 -1
- package/api/resources/editRuns/client/Client.d.ts +7 -1
- package/api/resources/editRuns/client/Client.js +7 -1
- package/api/resources/editRuns/client/requests/EditRunsCreateRequest.d.ts +7 -1
- package/api/resources/evaluationSetItems/client/Client.d.ts +16 -4
- package/api/resources/evaluationSetItems/client/Client.js +16 -4
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsCreateRequest.d.ts +8 -2
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsUpdateRequest.d.ts +7 -1
- package/api/resources/evaluationSets/client/Client.d.ts +4 -3
- package/api/resources/evaluationSets/client/Client.js +4 -3
- package/api/resources/evaluationSets/client/requests/EvaluationSetsCreateRequest.d.ts +3 -2
- package/api/resources/extractRuns/client/Client.d.ts +4 -1
- package/api/resources/extractRuns/client/Client.js +4 -1
- package/api/resources/extractRuns/client/requests/ExtractRunsCreateRequest.d.ts +4 -1
- package/api/resources/extractorVersions/client/Client.d.ts +2 -1
- package/api/resources/extractorVersions/client/Client.js +2 -1
- package/api/resources/extractorVersions/client/requests/ExtractorVersionsCreateRequest.d.ts +2 -1
- package/api/resources/extractors/client/Client.d.ts +23 -2
- package/api/resources/extractors/client/Client.js +23 -2
- package/api/resources/extractors/client/requests/ExtractorsCreateRequest.d.ts +20 -1
- package/api/resources/extractors/client/requests/ExtractorsUpdateRequest.d.ts +3 -1
- package/api/resources/files/client/Client.d.ts +1 -1
- package/api/resources/files/client/Client.js +1 -1
- package/api/resources/index.d.ts +6 -0
- package/api/resources/index.js +7 -1
- package/api/resources/parseRuns/client/Client.d.ts +2 -1
- package/api/resources/parseRuns/client/Client.js +2 -1
- package/api/resources/parseRuns/client/requests/ParseRunsCreateRequest.d.ts +2 -1
- package/api/resources/processorRun/client/Client.d.ts +3 -3
- package/api/resources/processorRun/client/Client.js +3 -3
- package/api/resources/processorRun/client/requests/ProcessorRunCreateRequest.d.ts +1 -1
- package/api/resources/splitRuns/client/Client.d.ts +4 -1
- package/api/resources/splitRuns/client/Client.js +4 -1
- package/api/resources/splitRuns/client/requests/SplitRunsCreateRequest.d.ts +4 -1
- package/api/resources/splitterVersions/client/Client.d.ts +2 -1
- package/api/resources/splitterVersions/client/Client.js +2 -1
- package/api/resources/splitterVersions/client/requests/SplitterVersionsCreateRequest.d.ts +2 -1
- package/api/resources/splitters/client/Client.d.ts +21 -2
- package/api/resources/splitters/client/Client.js +21 -2
- package/api/resources/splitters/client/requests/SplittersCreateRequest.d.ts +18 -1
- package/api/resources/splitters/client/requests/SplittersUpdateRequest.d.ts +3 -1
- package/api/resources/webhookEndpoints/client/Client.d.ts +133 -0
- package/api/resources/webhookEndpoints/client/Client.js +440 -0
- package/api/resources/webhookEndpoints/client/index.d.ts +1 -0
- package/api/resources/webhookEndpoints/client/index.js +17 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsCreateRequest.d.ts +21 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsCreateRequest.js +3 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsListRequest.d.ts +14 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsListRequest.js +3 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsUpdateRequest.d.ts +15 -0
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsUpdateRequest.js +3 -0
- package/api/resources/webhookEndpoints/client/requests/index.d.ts +3 -0
- package/api/resources/webhookEndpoints/client/requests/index.js +2 -0
- package/api/resources/webhookEndpoints/index.d.ts +2 -0
- package/api/resources/webhookEndpoints/index.js +18 -0
- package/api/resources/webhookEndpoints/types/WebhookEndpointsDeleteResponse.d.ts +4 -0
- package/api/resources/webhookEndpoints/types/WebhookEndpointsDeleteResponse.js +3 -0
- package/api/resources/webhookEndpoints/types/WebhookEndpointsListResponse.d.ts +6 -0
- package/api/resources/webhookEndpoints/types/WebhookEndpointsListResponse.js +3 -0
- package/api/resources/webhookEndpoints/types/index.d.ts +2 -0
- package/api/resources/webhookEndpoints/types/index.js +18 -0
- package/api/resources/webhookSubscriptions/client/Client.d.ts +133 -0
- package/api/resources/webhookSubscriptions/client/Client.js +444 -0
- package/api/resources/webhookSubscriptions/client/index.d.ts +1 -0
- package/api/resources/webhookSubscriptions/client/index.js +17 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsCreateRequest.d.ts +19 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsCreateRequest.js +3 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsListRequest.d.ts +16 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsListRequest.js +3 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsUpdateRequest.d.ts +11 -0
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsUpdateRequest.js +3 -0
- package/api/resources/webhookSubscriptions/client/requests/index.d.ts +3 -0
- package/api/resources/webhookSubscriptions/client/requests/index.js +2 -0
- package/api/resources/webhookSubscriptions/index.d.ts +2 -0
- package/api/resources/webhookSubscriptions/index.js +18 -0
- package/api/resources/webhookSubscriptions/types/WebhookSubscriptionsDeleteResponse.d.ts +4 -0
- package/api/resources/webhookSubscriptions/types/WebhookSubscriptionsDeleteResponse.js +3 -0
- package/api/resources/webhookSubscriptions/types/WebhookSubscriptionsListResponse.d.ts +6 -0
- package/api/resources/webhookSubscriptions/types/WebhookSubscriptionsListResponse.js +3 -0
- package/api/resources/webhookSubscriptions/types/index.d.ts +2 -0
- package/api/resources/webhookSubscriptions/types/index.js +18 -0
- package/api/resources/workflowRuns/client/Client.d.ts +22 -6
- package/api/resources/workflowRuns/client/Client.js +22 -6
- package/api/resources/workflowRuns/client/requests/WorkflowRunsCreateBatchRequest.d.ts +12 -2
- package/api/resources/workflowRuns/client/requests/WorkflowRunsCreateRequest.d.ts +3 -3
- package/api/resources/workflowRuns/client/requests/WorkflowRunsListRequest.d.ts +1 -1
- package/api/resources/workflowRuns/client/requests/WorkflowRunsUpdateRequest.d.ts +7 -1
- package/api/resources/workflowRuns/types/WorkflowRunsCreateRequestFile.d.ts +1 -1
- package/api/types/EditConfigAdvancedOptions.d.ts +4 -0
- package/api/types/EditJson.d.ts +2 -0
- package/api/types/ExtractAdvancedOptions.d.ts +1 -1
- package/api/types/ExtractAdvancedOptionsReviewAgent.d.ts +1 -1
- package/api/types/ExtractConfigJson.d.ts +1 -1
- package/api/types/ExtractOutputMetadataValue.d.ts +1 -1
- package/api/types/ExtractOverrideConfigJson.d.ts +1 -1
- package/api/types/ExtractRun.d.ts +10 -2
- package/api/types/ExtractorVersion.d.ts +6 -1
- package/api/types/LegacyClassificationAdvancedOptions.d.ts +1 -1
- package/api/types/LegacyClassificationConfig.d.ts +2 -2
- package/api/types/LegacyClassificationConfigBaseProcessor.d.ts +1 -1
- package/api/types/LegacyClassificationConfigBaseProcessor.js +1 -1
- package/api/types/LegacyDocumentProcessorRunCredits.d.ts +2 -2
- package/api/types/LegacyExtractionAdvancedOptions.d.ts +2 -2
- package/api/types/LegacyExtractionAdvancedOptionsReviewAgent.d.ts +1 -1
- package/api/types/LegacyExtractionConfig.d.ts +3 -3
- package/api/types/LegacyExtractionConfigBaseProcessor.d.ts +1 -1
- package/api/types/LegacyExtractionConfigBaseProcessor.js +1 -1
- package/api/types/LegacyJsonOutputMetadataValue.d.ts +1 -1
- package/api/types/LegacySplitterAdvancedOptions.d.ts +6 -2
- package/api/types/LegacySplitterAdvancedOptionsSplitMethod.d.ts +5 -1
- package/api/types/LegacySplitterAdvancedOptionsSplitMethod.js +5 -1
- package/api/types/LegacySplitterConfig.d.ts +2 -2
- package/api/types/LegacySplitterConfigBaseProcessor.d.ts +1 -1
- package/api/types/LegacySplitterConfigBaseProcessor.js +1 -1
- package/api/types/ParseConfig.d.ts +1 -1
- package/api/types/ParseConfigTarget.d.ts +1 -1
- package/api/types/ParseConfigTarget.js +1 -1
- package/api/types/SplitAdvancedOptions.d.ts +10 -2
- package/api/types/SplitAdvancedOptionsSplitMethod.d.ts +5 -1
- package/api/types/SplitAdvancedOptionsSplitMethod.js +5 -1
- package/api/types/SplitClassification.d.ts +19 -0
- package/api/types/SplitClassification.js +3 -0
- package/api/types/SplitClassifications.d.ts +5 -0
- package/api/types/SplitClassifications.js +3 -0
- package/api/types/SplitConfig.d.ts +1 -1
- package/api/types/SplitOverrideConfig.d.ts +1 -1
- package/api/types/WebhookAdvancedOptions.d.ts +9 -0
- package/api/types/WebhookAdvancedOptions.js +3 -0
- package/api/types/WebhookEndpoint.d.ts +18 -0
- package/api/types/WebhookEndpoint.js +3 -0
- package/api/types/WebhookEndpointCreate.d.ts +27 -0
- package/api/types/WebhookEndpointCreate.js +3 -0
- package/api/types/WebhookEndpointEventType.d.ts +32 -0
- package/api/types/WebhookEndpointEventType.js +35 -0
- package/api/types/WebhookEndpointStatus.d.ts +6 -0
- package/api/types/WebhookEndpointStatus.js +9 -0
- package/api/types/WebhookPayloadFormat.d.ts +11 -0
- package/api/types/WebhookPayloadFormat.js +14 -0
- package/api/types/WebhookPayloadOptions.d.ts +9 -0
- package/api/types/WebhookPayloadOptions.js +3 -0
- package/api/types/WebhookSubscription.d.ts +15 -0
- package/api/types/WebhookSubscription.js +3 -0
- package/api/types/WebhookSubscriptionEventType.d.ts +23 -0
- package/api/types/WebhookSubscriptionEventType.js +26 -0
- package/api/types/WebhookSubscriptionResourceType.d.ts +8 -0
- package/api/types/WebhookSubscriptionResourceType.js +11 -0
- package/api/types/index.d.ts +12 -0
- package/api/types/index.js +12 -0
- package/package.json +1 -1
- package/reference.md +901 -40
- package/version.d.ts +1 -1
- package/version.js +1 -1
package/reference.md
CHANGED
|
@@ -34,7 +34,8 @@ For more details, see the [Parse File guide](https://docs.extend.ai/2026-02-09/p
|
|
|
34
34
|
```typescript
|
|
35
35
|
await client.parse({
|
|
36
36
|
file: {
|
|
37
|
-
url: "
|
|
37
|
+
url: "https://example.com/bank_statement.pdf",
|
|
38
|
+
name: "bank_statement.pdf"
|
|
38
39
|
}
|
|
39
40
|
});
|
|
40
41
|
|
|
@@ -107,7 +108,13 @@ For more details, see the [Edit File guide](https://docs.extend.ai/2026-02-09/pr
|
|
|
107
108
|
```typescript
|
|
108
109
|
await client.edit({
|
|
109
110
|
file: {
|
|
110
|
-
url: "
|
|
111
|
+
url: "https://example.com/form.pdf"
|
|
112
|
+
},
|
|
113
|
+
config: {
|
|
114
|
+
instructions: "Fill out the form with the provided data",
|
|
115
|
+
advancedOptions: {
|
|
116
|
+
flattenPdf: true
|
|
117
|
+
}
|
|
111
118
|
}
|
|
112
119
|
});
|
|
113
120
|
|
|
@@ -163,7 +170,7 @@ Extract structured data from a file synchronously, waiting for the result before
|
|
|
163
170
|
|
|
164
171
|
The Extract endpoint allows you to extract structured data from files using an existing extractor or an inline configuration.
|
|
165
172
|
|
|
166
|
-
For more details, see the [Extract File guide](https://docs.extend.ai/2026-02-09/product/
|
|
173
|
+
For more details, see the [Extract File guide](https://docs.extend.ai/2026-02-09/product/extraction/quick-start-5-minutes).
|
|
167
174
|
</dd>
|
|
168
175
|
</dl>
|
|
169
176
|
</dd>
|
|
@@ -179,8 +186,27 @@ For more details, see the [Extract File guide](https://docs.extend.ai/2026-02-09
|
|
|
179
186
|
|
|
180
187
|
```typescript
|
|
181
188
|
await client.extract({
|
|
189
|
+
config: {
|
|
190
|
+
schema: {
|
|
191
|
+
"type": "object",
|
|
192
|
+
"properties": {
|
|
193
|
+
"vendor_name": {
|
|
194
|
+
"type": "string",
|
|
195
|
+
"description": "The name of the vendor"
|
|
196
|
+
},
|
|
197
|
+
"invoice_number": {
|
|
198
|
+
"type": "string",
|
|
199
|
+
"description": "The invoice number"
|
|
200
|
+
},
|
|
201
|
+
"total_amount": {
|
|
202
|
+
"type": "number",
|
|
203
|
+
"description": "The total amount due"
|
|
204
|
+
}
|
|
205
|
+
}
|
|
206
|
+
}
|
|
207
|
+
},
|
|
182
208
|
file: {
|
|
183
|
-
url: "
|
|
209
|
+
url: "https://example.com/invoice.pdf"
|
|
184
210
|
}
|
|
185
211
|
});
|
|
186
212
|
|
|
@@ -236,7 +262,7 @@ Classify a document synchronously, waiting for the result before returning. This
|
|
|
236
262
|
|
|
237
263
|
The Classify endpoint allows you to classify documents using an existing classifier or an inline configuration.
|
|
238
264
|
|
|
239
|
-
For more details, see the [Classify File guide](https://docs.extend.ai/2026-02-09/product/
|
|
265
|
+
For more details, see the [Classify File guide](https://docs.extend.ai/2026-02-09/product/classification/configuring-a-classifier).
|
|
240
266
|
</dd>
|
|
241
267
|
</dl>
|
|
242
268
|
</dd>
|
|
@@ -252,8 +278,23 @@ For more details, see the [Classify File guide](https://docs.extend.ai/2026-02-0
|
|
|
252
278
|
|
|
253
279
|
```typescript
|
|
254
280
|
await client.classify({
|
|
281
|
+
config: {
|
|
282
|
+
classifications: [{
|
|
283
|
+
id: "invoice",
|
|
284
|
+
type: "invoice",
|
|
285
|
+
description: "An invoice or bill for goods or services"
|
|
286
|
+
}, {
|
|
287
|
+
id: "receipt",
|
|
288
|
+
type: "receipt",
|
|
289
|
+
description: "A receipt confirming payment"
|
|
290
|
+
}, {
|
|
291
|
+
id: "other",
|
|
292
|
+
type: "other",
|
|
293
|
+
description: "Any other document type"
|
|
294
|
+
}]
|
|
295
|
+
},
|
|
255
296
|
file: {
|
|
256
|
-
url: "
|
|
297
|
+
url: "https://example.com/document.pdf"
|
|
257
298
|
}
|
|
258
299
|
});
|
|
259
300
|
|
|
@@ -309,7 +350,7 @@ Split a document synchronously, waiting for the result before returning. This en
|
|
|
309
350
|
|
|
310
351
|
The Split endpoint allows you to split documents into multiple parts using an existing splitter or an inline configuration.
|
|
311
352
|
|
|
312
|
-
For more details, see the [Split File guide](https://docs.extend.ai/2026-02-09/product/splitting/
|
|
353
|
+
For more details, see the [Split File guide](https://docs.extend.ai/2026-02-09/product/splitting/configuring-a-splitter).
|
|
313
354
|
</dd>
|
|
314
355
|
</dl>
|
|
315
356
|
</dd>
|
|
@@ -325,8 +366,25 @@ For more details, see the [Split File guide](https://docs.extend.ai/2026-02-09/p
|
|
|
325
366
|
|
|
326
367
|
```typescript
|
|
327
368
|
await client.split({
|
|
369
|
+
config: {
|
|
370
|
+
splitClassifications: [{
|
|
371
|
+
id: "invoice",
|
|
372
|
+
type: "invoice",
|
|
373
|
+
description: "An invoice or bill for goods or services",
|
|
374
|
+
identifierKey: "invoice number from the document header"
|
|
375
|
+
}, {
|
|
376
|
+
id: "receipt",
|
|
377
|
+
type: "receipt",
|
|
378
|
+
description: "A receipt confirming payment",
|
|
379
|
+
identifierKey: "receipt number"
|
|
380
|
+
}, {
|
|
381
|
+
id: "other",
|
|
382
|
+
type: "other",
|
|
383
|
+
description: "Any other document type"
|
|
384
|
+
}]
|
|
385
|
+
},
|
|
328
386
|
file: {
|
|
329
|
-
url: "
|
|
387
|
+
url: "https://example.com/multi-document.pdf"
|
|
330
388
|
}
|
|
331
389
|
});
|
|
332
390
|
|
|
@@ -588,7 +646,7 @@ Example: `"file_xK9mLPqRtN3vS8wF5hB2cQ"`
|
|
|
588
646
|
|
|
589
647
|
Upload and create a new file in Extend.
|
|
590
648
|
|
|
591
|
-
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/
|
|
649
|
+
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.
|
|
592
650
|
|
|
593
651
|
If an uploaded file is detected as a Word or PowerPoint document, it will be automatically converted to a PDF.
|
|
594
652
|
|
|
@@ -679,7 +737,8 @@ The request returns immediately with a `PROCESSING` status. Use webhooks or poll
|
|
|
679
737
|
```typescript
|
|
680
738
|
await client.parseRuns.create({
|
|
681
739
|
file: {
|
|
682
|
-
url: "
|
|
740
|
+
url: "https://example.com/bank_statement.pdf",
|
|
741
|
+
name: "bank_statement.pdf"
|
|
683
742
|
}
|
|
684
743
|
});
|
|
685
744
|
|
|
@@ -897,7 +956,13 @@ The request returns immediately with a `PROCESSING` status. Use webhooks or poll
|
|
|
897
956
|
```typescript
|
|
898
957
|
await client.editRuns.create({
|
|
899
958
|
file: {
|
|
900
|
-
url: "
|
|
959
|
+
url: "https://example.com/form.pdf"
|
|
960
|
+
},
|
|
961
|
+
config: {
|
|
962
|
+
instructions: "Fill out the form with the provided data",
|
|
963
|
+
advancedOptions: {
|
|
964
|
+
flattenPdf: true
|
|
965
|
+
}
|
|
901
966
|
}
|
|
902
967
|
});
|
|
903
968
|
|
|
@@ -1171,8 +1236,11 @@ The request returns immediately with a `PROCESSING` status. Use webhooks or poll
|
|
|
1171
1236
|
|
|
1172
1237
|
```typescript
|
|
1173
1238
|
await client.extractRuns.create({
|
|
1239
|
+
extractor: {
|
|
1240
|
+
id: "ex_1234567890"
|
|
1241
|
+
},
|
|
1174
1242
|
file: {
|
|
1175
|
-
url: "
|
|
1243
|
+
url: "https://example.com/invoice.pdf"
|
|
1176
1244
|
}
|
|
1177
1245
|
});
|
|
1178
1246
|
|
|
@@ -1509,7 +1577,26 @@ Create a new extractor.
|
|
|
1509
1577
|
|
|
1510
1578
|
```typescript
|
|
1511
1579
|
await client.extractors.create({
|
|
1512
|
-
name: "
|
|
1580
|
+
name: "Invoice Extractor",
|
|
1581
|
+
config: {
|
|
1582
|
+
schema: {
|
|
1583
|
+
"type": "object",
|
|
1584
|
+
"properties": {
|
|
1585
|
+
"vendor_name": {
|
|
1586
|
+
"type": "string",
|
|
1587
|
+
"description": "The name of the vendor"
|
|
1588
|
+
},
|
|
1589
|
+
"invoice_number": {
|
|
1590
|
+
"type": "string",
|
|
1591
|
+
"description": "The invoice number"
|
|
1592
|
+
},
|
|
1593
|
+
"total_amount": {
|
|
1594
|
+
"type": "number",
|
|
1595
|
+
"description": "The total amount due"
|
|
1596
|
+
}
|
|
1597
|
+
}
|
|
1598
|
+
}
|
|
1599
|
+
}
|
|
1513
1600
|
});
|
|
1514
1601
|
|
|
1515
1602
|
```
|
|
@@ -1640,7 +1727,9 @@ Update an existing extractor.
|
|
|
1640
1727
|
<dd>
|
|
1641
1728
|
|
|
1642
1729
|
```typescript
|
|
1643
|
-
await client.extractors.update("extractor_id_here"
|
|
1730
|
+
await client.extractors.update("extractor_id_here", {
|
|
1731
|
+
name: "Invoice Extractor v2"
|
|
1732
|
+
});
|
|
1644
1733
|
|
|
1645
1734
|
```
|
|
1646
1735
|
</dd>
|
|
@@ -1798,7 +1887,8 @@ Publishing a new version does not automatically update existing workflows using
|
|
|
1798
1887
|
|
|
1799
1888
|
```typescript
|
|
1800
1889
|
await client.extractorVersions.create("extractor_id_here", {
|
|
1801
|
-
releaseType: "
|
|
1890
|
+
releaseType: "minor",
|
|
1891
|
+
description: "Updated extraction rules for better accuracy"
|
|
1802
1892
|
});
|
|
1803
1893
|
|
|
1804
1894
|
```
|
|
@@ -2024,8 +2114,11 @@ The request returns immediately with a `PROCESSING` status. Use webhooks or poll
|
|
|
2024
2114
|
|
|
2025
2115
|
```typescript
|
|
2026
2116
|
await client.classifyRuns.create({
|
|
2117
|
+
classifier: {
|
|
2118
|
+
id: "cl_1234567890"
|
|
2119
|
+
},
|
|
2027
2120
|
file: {
|
|
2028
|
-
url: "
|
|
2121
|
+
url: "https://example.com/document.pdf"
|
|
2029
2122
|
}
|
|
2030
2123
|
});
|
|
2031
2124
|
|
|
@@ -2362,7 +2455,22 @@ Create a new classifier.
|
|
|
2362
2455
|
|
|
2363
2456
|
```typescript
|
|
2364
2457
|
await client.classifiers.create({
|
|
2365
|
-
name: "
|
|
2458
|
+
name: "Document Classifier",
|
|
2459
|
+
config: {
|
|
2460
|
+
classifications: [{
|
|
2461
|
+
id: "invoice",
|
|
2462
|
+
type: "invoice",
|
|
2463
|
+
description: "An invoice or bill for goods or services"
|
|
2464
|
+
}, {
|
|
2465
|
+
id: "receipt",
|
|
2466
|
+
type: "receipt",
|
|
2467
|
+
description: "A receipt confirming payment"
|
|
2468
|
+
}, {
|
|
2469
|
+
id: "other",
|
|
2470
|
+
type: "other",
|
|
2471
|
+
description: "Any other document type"
|
|
2472
|
+
}]
|
|
2473
|
+
}
|
|
2366
2474
|
});
|
|
2367
2475
|
|
|
2368
2476
|
```
|
|
@@ -2493,7 +2601,9 @@ Update an existing classifier.
|
|
|
2493
2601
|
<dd>
|
|
2494
2602
|
|
|
2495
2603
|
```typescript
|
|
2496
|
-
await client.classifiers.update("classifier_id_here"
|
|
2604
|
+
await client.classifiers.update("classifier_id_here", {
|
|
2605
|
+
name: "Document Classifier v2"
|
|
2606
|
+
});
|
|
2497
2607
|
|
|
2498
2608
|
```
|
|
2499
2609
|
</dd>
|
|
@@ -2651,7 +2761,8 @@ Publishing a new version does not automatically update existing workflows using
|
|
|
2651
2761
|
|
|
2652
2762
|
```typescript
|
|
2653
2763
|
await client.classifierVersions.create("classifier_id_here", {
|
|
2654
|
-
releaseType: "
|
|
2764
|
+
releaseType: "minor",
|
|
2765
|
+
description: "Added new document classification type"
|
|
2655
2766
|
});
|
|
2656
2767
|
|
|
2657
2768
|
```
|
|
@@ -2877,8 +2988,11 @@ The request returns immediately with a `PROCESSING` status. Use webhooks or poll
|
|
|
2877
2988
|
|
|
2878
2989
|
```typescript
|
|
2879
2990
|
await client.splitRuns.create({
|
|
2991
|
+
splitter: {
|
|
2992
|
+
id: "spl_1234567890"
|
|
2993
|
+
},
|
|
2880
2994
|
file: {
|
|
2881
|
-
url: "
|
|
2995
|
+
url: "https://example.com/multi-document.pdf"
|
|
2882
2996
|
}
|
|
2883
2997
|
});
|
|
2884
2998
|
|
|
@@ -3215,7 +3329,24 @@ Create a new splitter.
|
|
|
3215
3329
|
|
|
3216
3330
|
```typescript
|
|
3217
3331
|
await client.splitters.create({
|
|
3218
|
-
name: "
|
|
3332
|
+
name: "Document Splitter",
|
|
3333
|
+
config: {
|
|
3334
|
+
splitClassifications: [{
|
|
3335
|
+
id: "invoice",
|
|
3336
|
+
type: "invoice",
|
|
3337
|
+
description: "An invoice or bill for goods or services",
|
|
3338
|
+
identifierKey: "invoice number from the document header"
|
|
3339
|
+
}, {
|
|
3340
|
+
id: "receipt",
|
|
3341
|
+
type: "receipt",
|
|
3342
|
+
description: "A receipt confirming payment",
|
|
3343
|
+
identifierKey: "receipt number"
|
|
3344
|
+
}, {
|
|
3345
|
+
id: "other",
|
|
3346
|
+
type: "other",
|
|
3347
|
+
description: "Any other document type"
|
|
3348
|
+
}]
|
|
3349
|
+
}
|
|
3219
3350
|
});
|
|
3220
3351
|
|
|
3221
3352
|
```
|
|
@@ -3346,7 +3477,9 @@ Update an existing splitter.
|
|
|
3346
3477
|
<dd>
|
|
3347
3478
|
|
|
3348
3479
|
```typescript
|
|
3349
|
-
await client.splitters.update("splitter_id_here"
|
|
3480
|
+
await client.splitters.update("splitter_id_here", {
|
|
3481
|
+
name: "Document Splitter v2"
|
|
3482
|
+
});
|
|
3350
3483
|
|
|
3351
3484
|
```
|
|
3352
3485
|
</dd>
|
|
@@ -3504,7 +3637,8 @@ Publishing a new version does not automatically update existing workflows using
|
|
|
3504
3637
|
|
|
3505
3638
|
```typescript
|
|
3506
3639
|
await client.splitterVersions.create("splitter_id_here", {
|
|
3507
|
-
releaseType: "
|
|
3640
|
+
releaseType: "minor",
|
|
3641
|
+
description: "Improved split boundary detection"
|
|
3508
3642
|
});
|
|
3509
3643
|
|
|
3510
3644
|
```
|
|
@@ -3797,10 +3931,10 @@ The request returns immediately with a `PROCESSING` status. Use webhooks or poll
|
|
|
3797
3931
|
```typescript
|
|
3798
3932
|
await client.workflowRuns.create({
|
|
3799
3933
|
workflow: {
|
|
3800
|
-
id: "
|
|
3934
|
+
id: "wf_1234567890"
|
|
3801
3935
|
},
|
|
3802
3936
|
file: {
|
|
3803
|
-
url: "
|
|
3937
|
+
url: "https://example.com/invoice.pdf"
|
|
3804
3938
|
}
|
|
3805
3939
|
});
|
|
3806
3940
|
|
|
@@ -3932,7 +4066,13 @@ You can update the name and metadata of an in progress WorkflowRun at any time u
|
|
|
3932
4066
|
<dd>
|
|
3933
4067
|
|
|
3934
4068
|
```typescript
|
|
3935
|
-
await client.workflowRuns.update("workflow_run_id_here"
|
|
4069
|
+
await client.workflowRuns.update("workflow_run_id_here", {
|
|
4070
|
+
name: "Invoice #12345",
|
|
4071
|
+
metadata: {
|
|
4072
|
+
"customerId": "cust_abc123",
|
|
4073
|
+
"source": "email-inbox"
|
|
4074
|
+
}
|
|
4075
|
+
});
|
|
3936
4076
|
|
|
3937
4077
|
```
|
|
3938
4078
|
</dd>
|
|
@@ -4132,7 +4272,7 @@ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
|
|
|
4132
4272
|
|
|
4133
4273
|
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.
|
|
4134
4274
|
|
|
4135
|
-
Unlike the single [Run Workflow](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/
|
|
4275
|
+
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`.
|
|
4136
4276
|
|
|
4137
4277
|
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.
|
|
4138
4278
|
|
|
@@ -4159,11 +4299,21 @@ Upon successful submission, the endpoint returns a `batchId`. The individual wor
|
|
|
4159
4299
|
```typescript
|
|
4160
4300
|
await client.workflowRuns.createBatch({
|
|
4161
4301
|
workflow: {
|
|
4162
|
-
id: "
|
|
4302
|
+
id: "wf_1234567890"
|
|
4163
4303
|
},
|
|
4164
4304
|
inputs: [{
|
|
4165
4305
|
file: {
|
|
4166
|
-
url: "
|
|
4306
|
+
url: "https://example.com/invoice1.pdf"
|
|
4307
|
+
},
|
|
4308
|
+
metadata: {
|
|
4309
|
+
"customerId": "cust_abc123"
|
|
4310
|
+
}
|
|
4311
|
+
}, {
|
|
4312
|
+
file: {
|
|
4313
|
+
url: "https://example.com/invoice2.pdf"
|
|
4314
|
+
},
|
|
4315
|
+
metadata: {
|
|
4316
|
+
"customerId": "cust_def456"
|
|
4167
4317
|
}
|
|
4168
4318
|
}]
|
|
4169
4319
|
});
|
|
@@ -4287,8 +4437,8 @@ Run processors (extraction, classification, splitting, etc.) on a given document
|
|
|
4287
4437
|
- **Synchronous**: Set `sync: true` to wait for completion and get final results in the response (5-minute timeout).
|
|
4288
4438
|
|
|
4289
4439
|
**For asynchronous processing:**
|
|
4290
|
-
- You can [configure webhooks](https://docs.extend.ai/product/webhooks/configuration) to receive notifications when a processor run is complete or failed.
|
|
4291
|
-
- Or you can [poll the get endpoint](https://docs.extend.ai/
|
|
4440
|
+
- 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.
|
|
4441
|
+
- 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.
|
|
4292
4442
|
</dd>
|
|
4293
4443
|
</dl>
|
|
4294
4444
|
</dd>
|
|
@@ -4355,7 +4505,7 @@ await client.processorRun.create({
|
|
|
4355
4505
|
|
|
4356
4506
|
Retrieve details about a specific processor run, including its status, outputs, and any edits made during review.
|
|
4357
4507
|
|
|
4358
|
-
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/
|
|
4508
|
+
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.
|
|
4359
4509
|
</dd>
|
|
4360
4510
|
</dl>
|
|
4361
4511
|
</dd>
|
|
@@ -4997,7 +5147,7 @@ Example: `"exv_QYk6jgHA_8CsO8rVWhyNC"`
|
|
|
4997
5147
|
|
|
4998
5148
|
Retrieve details about a batch processor run, including evaluation runs.
|
|
4999
5149
|
|
|
5000
|
-
**Deprecated:** This endpoint is maintained for backwards compatibility only and will be replaced in a future API version. Use [Get Evaluation Set Run](/2026-02-09/developers/api-reference/endpoints/evaluation/get-evaluation-set-run) for interacting with evaluation set runs.
|
|
5150
|
+
**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.
|
|
5001
5151
|
</dd>
|
|
5002
5152
|
</dl>
|
|
5003
5153
|
</dd>
|
|
@@ -5133,7 +5283,7 @@ await client.evaluationSets.list({
|
|
|
5133
5283
|
|
|
5134
5284
|
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.
|
|
5135
5285
|
|
|
5136
|
-
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/product/evaluation/overview) product page.
|
|
5286
|
+
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.
|
|
5137
5287
|
</dd>
|
|
5138
5288
|
</dl>
|
|
5139
5289
|
</dd>
|
|
@@ -5149,8 +5299,9 @@ Note: It is not necessary to create an evaluation set via API. You can also crea
|
|
|
5149
5299
|
|
|
5150
5300
|
```typescript
|
|
5151
5301
|
await client.evaluationSets.create({
|
|
5152
|
-
name: "
|
|
5153
|
-
|
|
5302
|
+
name: "Invoice Processing Test Set",
|
|
5303
|
+
description: "Q4 vendor invoices for accuracy testing",
|
|
5304
|
+
entityId: "ex_1234567890"
|
|
5154
5305
|
});
|
|
5155
5306
|
|
|
5156
5307
|
```
|
|
@@ -5350,7 +5501,7 @@ Evaluation set items are the individual files and expected outputs that are used
|
|
|
5350
5501
|
|
|
5351
5502
|
**Limit:** You can create up to 100 items at a time.
|
|
5352
5503
|
|
|
5353
|
-
Learn more about how to create evaluation set items in the [Evaluation Sets](https://docs.extend.ai/product/evaluation/overview) product page.
|
|
5504
|
+
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.
|
|
5354
5505
|
</dd>
|
|
5355
5506
|
</dl>
|
|
5356
5507
|
</dd>
|
|
@@ -5367,8 +5518,14 @@ Learn more about how to create evaluation set items in the [Evaluation Sets](htt
|
|
|
5367
5518
|
```typescript
|
|
5368
5519
|
await client.evaluationSetItems.create("evaluation_set_id_here", {
|
|
5369
5520
|
items: [{
|
|
5370
|
-
fileId: "
|
|
5371
|
-
expectedOutput: {
|
|
5521
|
+
fileId: "file_xK9mLPqRtN3vS8wF5hB2cQ",
|
|
5522
|
+
expectedOutput: {
|
|
5523
|
+
value: {
|
|
5524
|
+
"vendor_name": "Acme Corp",
|
|
5525
|
+
"invoice_number": "INV-001",
|
|
5526
|
+
"total_amount": 1500
|
|
5527
|
+
}
|
|
5528
|
+
}
|
|
5372
5529
|
}]
|
|
5373
5530
|
});
|
|
5374
5531
|
|
|
@@ -5525,7 +5682,13 @@ If you need to change the expected output for a given evaluation set item, you c
|
|
|
5525
5682
|
|
|
5526
5683
|
```typescript
|
|
5527
5684
|
await client.evaluationSetItems.update("evaluation_set_id_here", "evaluation_set_item_id_here", {
|
|
5528
|
-
expectedOutput: {
|
|
5685
|
+
expectedOutput: {
|
|
5686
|
+
value: {
|
|
5687
|
+
"vendor_name": "Acme Corp",
|
|
5688
|
+
"invoice_number": "INV-001",
|
|
5689
|
+
"total_amount": 1750
|
|
5690
|
+
}
|
|
5691
|
+
}
|
|
5529
5692
|
});
|
|
5530
5693
|
|
|
5531
5694
|
```
|
|
@@ -5729,6 +5892,704 @@ Example: `"evr_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
|
5729
5892
|
</dl>
|
|
5730
5893
|
|
|
5731
5894
|
|
|
5895
|
+
</dd>
|
|
5896
|
+
</dl>
|
|
5897
|
+
</details>
|
|
5898
|
+
|
|
5899
|
+
## WebhookEndpoints
|
|
5900
|
+
<details><summary><code>client.webhookEndpoints.<a href="/src/api/resources/webhookEndpoints/client/Client.ts">list</a>({ ...params }) -> Extend.WebhookEndpointsListResponse</code></summary>
|
|
5901
|
+
<dl>
|
|
5902
|
+
<dd>
|
|
5903
|
+
|
|
5904
|
+
#### 📝 Description
|
|
5905
|
+
|
|
5906
|
+
<dl>
|
|
5907
|
+
<dd>
|
|
5908
|
+
|
|
5909
|
+
<dl>
|
|
5910
|
+
<dd>
|
|
5911
|
+
|
|
5912
|
+
List all webhook endpoints.
|
|
5913
|
+
</dd>
|
|
5914
|
+
</dl>
|
|
5915
|
+
</dd>
|
|
5916
|
+
</dl>
|
|
5917
|
+
|
|
5918
|
+
#### 🔌 Usage
|
|
5919
|
+
|
|
5920
|
+
<dl>
|
|
5921
|
+
<dd>
|
|
5922
|
+
|
|
5923
|
+
<dl>
|
|
5924
|
+
<dd>
|
|
5925
|
+
|
|
5926
|
+
```typescript
|
|
5927
|
+
await client.webhookEndpoints.list({
|
|
5928
|
+
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
|
|
5929
|
+
});
|
|
5930
|
+
|
|
5931
|
+
```
|
|
5932
|
+
</dd>
|
|
5933
|
+
</dl>
|
|
5934
|
+
</dd>
|
|
5935
|
+
</dl>
|
|
5936
|
+
|
|
5937
|
+
#### ⚙️ Parameters
|
|
5938
|
+
|
|
5939
|
+
<dl>
|
|
5940
|
+
<dd>
|
|
5941
|
+
|
|
5942
|
+
<dl>
|
|
5943
|
+
<dd>
|
|
5944
|
+
|
|
5945
|
+
**request:** `Extend.WebhookEndpointsListRequest`
|
|
5946
|
+
|
|
5947
|
+
</dd>
|
|
5948
|
+
</dl>
|
|
5949
|
+
|
|
5950
|
+
<dl>
|
|
5951
|
+
<dd>
|
|
5952
|
+
|
|
5953
|
+
**requestOptions:** `WebhookEndpointsClient.RequestOptions`
|
|
5954
|
+
|
|
5955
|
+
</dd>
|
|
5956
|
+
</dl>
|
|
5957
|
+
</dd>
|
|
5958
|
+
</dl>
|
|
5959
|
+
|
|
5960
|
+
|
|
5961
|
+
</dd>
|
|
5962
|
+
</dl>
|
|
5963
|
+
</details>
|
|
5964
|
+
|
|
5965
|
+
<details><summary><code>client.webhookEndpoints.<a href="/src/api/resources/webhookEndpoints/client/Client.ts">create</a>({ ...params }) -> Extend.WebhookEndpointCreate</code></summary>
|
|
5966
|
+
<dl>
|
|
5967
|
+
<dd>
|
|
5968
|
+
|
|
5969
|
+
#### 📝 Description
|
|
5970
|
+
|
|
5971
|
+
<dl>
|
|
5972
|
+
<dd>
|
|
5973
|
+
|
|
5974
|
+
<dl>
|
|
5975
|
+
<dd>
|
|
5976
|
+
|
|
5977
|
+
Create a new webhook endpoint. The response includes a `signingSecret` that is only returned once — store it securely for verifying webhook signatures.
|
|
5978
|
+
|
|
5979
|
+
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.
|
|
5980
|
+
|
|
5981
|
+
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.
|
|
5982
|
+
</dd>
|
|
5983
|
+
</dl>
|
|
5984
|
+
</dd>
|
|
5985
|
+
</dl>
|
|
5986
|
+
|
|
5987
|
+
#### 🔌 Usage
|
|
5988
|
+
|
|
5989
|
+
<dl>
|
|
5990
|
+
<dd>
|
|
5991
|
+
|
|
5992
|
+
<dl>
|
|
5993
|
+
<dd>
|
|
5994
|
+
|
|
5995
|
+
```typescript
|
|
5996
|
+
await client.webhookEndpoints.create({
|
|
5997
|
+
url: "https://example.com/webhooks",
|
|
5998
|
+
name: "Production webhook",
|
|
5999
|
+
enabledEvents: ["extract_run.processed", "workflow.created"],
|
|
6000
|
+
apiVersion: "2026-02-09"
|
|
6001
|
+
});
|
|
6002
|
+
|
|
6003
|
+
```
|
|
6004
|
+
</dd>
|
|
6005
|
+
</dl>
|
|
6006
|
+
</dd>
|
|
6007
|
+
</dl>
|
|
6008
|
+
|
|
6009
|
+
#### ⚙️ Parameters
|
|
6010
|
+
|
|
6011
|
+
<dl>
|
|
6012
|
+
<dd>
|
|
6013
|
+
|
|
6014
|
+
<dl>
|
|
6015
|
+
<dd>
|
|
6016
|
+
|
|
6017
|
+
**request:** `Extend.WebhookEndpointsCreateRequest`
|
|
6018
|
+
|
|
6019
|
+
</dd>
|
|
6020
|
+
</dl>
|
|
6021
|
+
|
|
6022
|
+
<dl>
|
|
6023
|
+
<dd>
|
|
6024
|
+
|
|
6025
|
+
**requestOptions:** `WebhookEndpointsClient.RequestOptions`
|
|
6026
|
+
|
|
6027
|
+
</dd>
|
|
6028
|
+
</dl>
|
|
6029
|
+
</dd>
|
|
6030
|
+
</dl>
|
|
6031
|
+
|
|
6032
|
+
|
|
6033
|
+
</dd>
|
|
6034
|
+
</dl>
|
|
6035
|
+
</details>
|
|
6036
|
+
|
|
6037
|
+
<details><summary><code>client.webhookEndpoints.<a href="/src/api/resources/webhookEndpoints/client/Client.ts">retrieve</a>(id) -> Extend.WebhookEndpoint</code></summary>
|
|
6038
|
+
<dl>
|
|
6039
|
+
<dd>
|
|
6040
|
+
|
|
6041
|
+
#### 📝 Description
|
|
6042
|
+
|
|
6043
|
+
<dl>
|
|
6044
|
+
<dd>
|
|
6045
|
+
|
|
6046
|
+
<dl>
|
|
6047
|
+
<dd>
|
|
6048
|
+
|
|
6049
|
+
Retrieve a webhook endpoint by ID.
|
|
6050
|
+
</dd>
|
|
6051
|
+
</dl>
|
|
6052
|
+
</dd>
|
|
6053
|
+
</dl>
|
|
6054
|
+
|
|
6055
|
+
#### 🔌 Usage
|
|
6056
|
+
|
|
6057
|
+
<dl>
|
|
6058
|
+
<dd>
|
|
6059
|
+
|
|
6060
|
+
<dl>
|
|
6061
|
+
<dd>
|
|
6062
|
+
|
|
6063
|
+
```typescript
|
|
6064
|
+
await client.webhookEndpoints.retrieve("webhook_endpoint_id_here");
|
|
6065
|
+
|
|
6066
|
+
```
|
|
6067
|
+
</dd>
|
|
6068
|
+
</dl>
|
|
6069
|
+
</dd>
|
|
6070
|
+
</dl>
|
|
6071
|
+
|
|
6072
|
+
#### ⚙️ Parameters
|
|
6073
|
+
|
|
6074
|
+
<dl>
|
|
6075
|
+
<dd>
|
|
6076
|
+
|
|
6077
|
+
<dl>
|
|
6078
|
+
<dd>
|
|
6079
|
+
|
|
6080
|
+
**id:** `string`
|
|
6081
|
+
|
|
6082
|
+
The ID of the webhook endpoint.
|
|
6083
|
+
|
|
6084
|
+
Example: `"wh_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
6085
|
+
|
|
6086
|
+
</dd>
|
|
6087
|
+
</dl>
|
|
6088
|
+
|
|
6089
|
+
<dl>
|
|
6090
|
+
<dd>
|
|
6091
|
+
|
|
6092
|
+
**requestOptions:** `WebhookEndpointsClient.RequestOptions`
|
|
6093
|
+
|
|
6094
|
+
</dd>
|
|
6095
|
+
</dl>
|
|
6096
|
+
</dd>
|
|
6097
|
+
</dl>
|
|
6098
|
+
|
|
6099
|
+
|
|
6100
|
+
</dd>
|
|
6101
|
+
</dl>
|
|
6102
|
+
</details>
|
|
6103
|
+
|
|
6104
|
+
<details><summary><code>client.webhookEndpoints.<a href="/src/api/resources/webhookEndpoints/client/Client.ts">update</a>(id, { ...params }) -> Extend.WebhookEndpoint</code></summary>
|
|
6105
|
+
<dl>
|
|
6106
|
+
<dd>
|
|
6107
|
+
|
|
6108
|
+
#### 📝 Description
|
|
6109
|
+
|
|
6110
|
+
<dl>
|
|
6111
|
+
<dd>
|
|
6112
|
+
|
|
6113
|
+
<dl>
|
|
6114
|
+
<dd>
|
|
6115
|
+
|
|
6116
|
+
Update a webhook endpoint. Only the fields you include in the request body will be updated; omitted fields remain unchanged.
|
|
6117
|
+
|
|
6118
|
+
The `apiVersion` of a webhook endpoint cannot be changed after creation.
|
|
6119
|
+
</dd>
|
|
6120
|
+
</dl>
|
|
6121
|
+
</dd>
|
|
6122
|
+
</dl>
|
|
6123
|
+
|
|
6124
|
+
#### 🔌 Usage
|
|
6125
|
+
|
|
6126
|
+
<dl>
|
|
6127
|
+
<dd>
|
|
6128
|
+
|
|
6129
|
+
<dl>
|
|
6130
|
+
<dd>
|
|
6131
|
+
|
|
6132
|
+
```typescript
|
|
6133
|
+
await client.webhookEndpoints.update("webhook_endpoint_id_here");
|
|
6134
|
+
|
|
6135
|
+
```
|
|
6136
|
+
</dd>
|
|
6137
|
+
</dl>
|
|
6138
|
+
</dd>
|
|
6139
|
+
</dl>
|
|
6140
|
+
|
|
6141
|
+
#### ⚙️ Parameters
|
|
6142
|
+
|
|
6143
|
+
<dl>
|
|
6144
|
+
<dd>
|
|
6145
|
+
|
|
6146
|
+
<dl>
|
|
6147
|
+
<dd>
|
|
6148
|
+
|
|
6149
|
+
**id:** `string`
|
|
6150
|
+
|
|
6151
|
+
The ID of the webhook endpoint to update.
|
|
6152
|
+
|
|
6153
|
+
Example: `"wh_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
6154
|
+
|
|
6155
|
+
</dd>
|
|
6156
|
+
</dl>
|
|
6157
|
+
|
|
6158
|
+
<dl>
|
|
6159
|
+
<dd>
|
|
6160
|
+
|
|
6161
|
+
**request:** `Extend.WebhookEndpointsUpdateRequest`
|
|
6162
|
+
|
|
6163
|
+
</dd>
|
|
6164
|
+
</dl>
|
|
6165
|
+
|
|
6166
|
+
<dl>
|
|
6167
|
+
<dd>
|
|
6168
|
+
|
|
6169
|
+
**requestOptions:** `WebhookEndpointsClient.RequestOptions`
|
|
6170
|
+
|
|
6171
|
+
</dd>
|
|
6172
|
+
</dl>
|
|
6173
|
+
</dd>
|
|
6174
|
+
</dl>
|
|
6175
|
+
|
|
6176
|
+
|
|
6177
|
+
</dd>
|
|
6178
|
+
</dl>
|
|
6179
|
+
</details>
|
|
6180
|
+
|
|
6181
|
+
<details><summary><code>client.webhookEndpoints.<a href="/src/api/resources/webhookEndpoints/client/Client.ts">delete</a>(id) -> Extend.WebhookEndpointsDeleteResponse</code></summary>
|
|
6182
|
+
<dl>
|
|
6183
|
+
<dd>
|
|
6184
|
+
|
|
6185
|
+
#### 📝 Description
|
|
6186
|
+
|
|
6187
|
+
<dl>
|
|
6188
|
+
<dd>
|
|
6189
|
+
|
|
6190
|
+
<dl>
|
|
6191
|
+
<dd>
|
|
6192
|
+
|
|
6193
|
+
Delete a webhook endpoint and all of its subscriptions. This operation is permanent and cannot be undone.
|
|
6194
|
+
</dd>
|
|
6195
|
+
</dl>
|
|
6196
|
+
</dd>
|
|
6197
|
+
</dl>
|
|
6198
|
+
|
|
6199
|
+
#### 🔌 Usage
|
|
6200
|
+
|
|
6201
|
+
<dl>
|
|
6202
|
+
<dd>
|
|
6203
|
+
|
|
6204
|
+
<dl>
|
|
6205
|
+
<dd>
|
|
6206
|
+
|
|
6207
|
+
```typescript
|
|
6208
|
+
await client.webhookEndpoints.delete("webhook_endpoint_id_here");
|
|
6209
|
+
|
|
6210
|
+
```
|
|
6211
|
+
</dd>
|
|
6212
|
+
</dl>
|
|
6213
|
+
</dd>
|
|
6214
|
+
</dl>
|
|
6215
|
+
|
|
6216
|
+
#### ⚙️ Parameters
|
|
6217
|
+
|
|
6218
|
+
<dl>
|
|
6219
|
+
<dd>
|
|
6220
|
+
|
|
6221
|
+
<dl>
|
|
6222
|
+
<dd>
|
|
6223
|
+
|
|
6224
|
+
**id:** `string`
|
|
6225
|
+
|
|
6226
|
+
The ID of the webhook endpoint to delete.
|
|
6227
|
+
|
|
6228
|
+
Example: `"wh_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
6229
|
+
|
|
6230
|
+
</dd>
|
|
6231
|
+
</dl>
|
|
6232
|
+
|
|
6233
|
+
<dl>
|
|
6234
|
+
<dd>
|
|
6235
|
+
|
|
6236
|
+
**requestOptions:** `WebhookEndpointsClient.RequestOptions`
|
|
6237
|
+
|
|
6238
|
+
</dd>
|
|
6239
|
+
</dl>
|
|
6240
|
+
</dd>
|
|
6241
|
+
</dl>
|
|
6242
|
+
|
|
6243
|
+
|
|
6244
|
+
</dd>
|
|
6245
|
+
</dl>
|
|
6246
|
+
</details>
|
|
6247
|
+
|
|
6248
|
+
## WebhookSubscriptions
|
|
6249
|
+
<details><summary><code>client.webhookSubscriptions.<a href="/src/api/resources/webhookSubscriptions/client/Client.ts">list</a>({ ...params }) -> Extend.WebhookSubscriptionsListResponse</code></summary>
|
|
6250
|
+
<dl>
|
|
6251
|
+
<dd>
|
|
6252
|
+
|
|
6253
|
+
#### 📝 Description
|
|
6254
|
+
|
|
6255
|
+
<dl>
|
|
6256
|
+
<dd>
|
|
6257
|
+
|
|
6258
|
+
<dl>
|
|
6259
|
+
<dd>
|
|
6260
|
+
|
|
6261
|
+
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.
|
|
6262
|
+
</dd>
|
|
6263
|
+
</dl>
|
|
6264
|
+
</dd>
|
|
6265
|
+
</dl>
|
|
6266
|
+
|
|
6267
|
+
#### 🔌 Usage
|
|
6268
|
+
|
|
6269
|
+
<dl>
|
|
6270
|
+
<dd>
|
|
6271
|
+
|
|
6272
|
+
<dl>
|
|
6273
|
+
<dd>
|
|
6274
|
+
|
|
6275
|
+
```typescript
|
|
6276
|
+
await client.webhookSubscriptions.list({
|
|
6277
|
+
nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
|
|
6278
|
+
});
|
|
6279
|
+
|
|
6280
|
+
```
|
|
6281
|
+
</dd>
|
|
6282
|
+
</dl>
|
|
6283
|
+
</dd>
|
|
6284
|
+
</dl>
|
|
6285
|
+
|
|
6286
|
+
#### ⚙️ Parameters
|
|
6287
|
+
|
|
6288
|
+
<dl>
|
|
6289
|
+
<dd>
|
|
6290
|
+
|
|
6291
|
+
<dl>
|
|
6292
|
+
<dd>
|
|
6293
|
+
|
|
6294
|
+
**request:** `Extend.WebhookSubscriptionsListRequest`
|
|
6295
|
+
|
|
6296
|
+
</dd>
|
|
6297
|
+
</dl>
|
|
6298
|
+
|
|
6299
|
+
<dl>
|
|
6300
|
+
<dd>
|
|
6301
|
+
|
|
6302
|
+
**requestOptions:** `WebhookSubscriptionsClient.RequestOptions`
|
|
6303
|
+
|
|
6304
|
+
</dd>
|
|
6305
|
+
</dl>
|
|
6306
|
+
</dd>
|
|
6307
|
+
</dl>
|
|
6308
|
+
|
|
6309
|
+
|
|
6310
|
+
</dd>
|
|
6311
|
+
</dl>
|
|
6312
|
+
</details>
|
|
6313
|
+
|
|
6314
|
+
<details><summary><code>client.webhookSubscriptions.<a href="/src/api/resources/webhookSubscriptions/client/Client.ts">create</a>({ ...params }) -> Extend.WebhookSubscription</code></summary>
|
|
6315
|
+
<dl>
|
|
6316
|
+
<dd>
|
|
6317
|
+
|
|
6318
|
+
#### 📝 Description
|
|
6319
|
+
|
|
6320
|
+
<dl>
|
|
6321
|
+
<dd>
|
|
6322
|
+
|
|
6323
|
+
<dl>
|
|
6324
|
+
<dd>
|
|
6325
|
+
|
|
6326
|
+
Create a resource-scoped webhook subscription on an existing webhook endpoint.
|
|
6327
|
+
|
|
6328
|
+
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`.
|
|
6329
|
+
|
|
6330
|
+
If a subscription already exists for the same endpoint and resource, it will be updated with the new `enabledEvents` instead of creating a duplicate.
|
|
6331
|
+
</dd>
|
|
6332
|
+
</dl>
|
|
6333
|
+
</dd>
|
|
6334
|
+
</dl>
|
|
6335
|
+
|
|
6336
|
+
#### 🔌 Usage
|
|
6337
|
+
|
|
6338
|
+
<dl>
|
|
6339
|
+
<dd>
|
|
6340
|
+
|
|
6341
|
+
<dl>
|
|
6342
|
+
<dd>
|
|
6343
|
+
|
|
6344
|
+
```typescript
|
|
6345
|
+
await client.webhookSubscriptions.create({
|
|
6346
|
+
webhookEndpointId: "wh_Xj8mK2pL9nR4vT7qY5wZ",
|
|
6347
|
+
resourceType: "extractor",
|
|
6348
|
+
resourceId: "ex_Xj8mK2pL9nR4vT7qY5wZ",
|
|
6349
|
+
enabledEvents: ["extract_run.processed", "extract_run.failed"]
|
|
6350
|
+
});
|
|
6351
|
+
|
|
6352
|
+
```
|
|
6353
|
+
</dd>
|
|
6354
|
+
</dl>
|
|
6355
|
+
</dd>
|
|
6356
|
+
</dl>
|
|
6357
|
+
|
|
6358
|
+
#### ⚙️ Parameters
|
|
6359
|
+
|
|
6360
|
+
<dl>
|
|
6361
|
+
<dd>
|
|
6362
|
+
|
|
6363
|
+
<dl>
|
|
6364
|
+
<dd>
|
|
6365
|
+
|
|
6366
|
+
**request:** `Extend.WebhookSubscriptionsCreateRequest`
|
|
6367
|
+
|
|
6368
|
+
</dd>
|
|
6369
|
+
</dl>
|
|
6370
|
+
|
|
6371
|
+
<dl>
|
|
6372
|
+
<dd>
|
|
6373
|
+
|
|
6374
|
+
**requestOptions:** `WebhookSubscriptionsClient.RequestOptions`
|
|
6375
|
+
|
|
6376
|
+
</dd>
|
|
6377
|
+
</dl>
|
|
6378
|
+
</dd>
|
|
6379
|
+
</dl>
|
|
6380
|
+
|
|
6381
|
+
|
|
6382
|
+
</dd>
|
|
6383
|
+
</dl>
|
|
6384
|
+
</details>
|
|
6385
|
+
|
|
6386
|
+
<details><summary><code>client.webhookSubscriptions.<a href="/src/api/resources/webhookSubscriptions/client/Client.ts">retrieve</a>(id) -> Extend.WebhookSubscription</code></summary>
|
|
6387
|
+
<dl>
|
|
6388
|
+
<dd>
|
|
6389
|
+
|
|
6390
|
+
#### 📝 Description
|
|
6391
|
+
|
|
6392
|
+
<dl>
|
|
6393
|
+
<dd>
|
|
6394
|
+
|
|
6395
|
+
<dl>
|
|
6396
|
+
<dd>
|
|
6397
|
+
|
|
6398
|
+
Retrieve a webhook subscription by ID.
|
|
6399
|
+
</dd>
|
|
6400
|
+
</dl>
|
|
6401
|
+
</dd>
|
|
6402
|
+
</dl>
|
|
6403
|
+
|
|
6404
|
+
#### 🔌 Usage
|
|
6405
|
+
|
|
6406
|
+
<dl>
|
|
6407
|
+
<dd>
|
|
6408
|
+
|
|
6409
|
+
<dl>
|
|
6410
|
+
<dd>
|
|
6411
|
+
|
|
6412
|
+
```typescript
|
|
6413
|
+
await client.webhookSubscriptions.retrieve("webhook_subscription_id_here");
|
|
6414
|
+
|
|
6415
|
+
```
|
|
6416
|
+
</dd>
|
|
6417
|
+
</dl>
|
|
6418
|
+
</dd>
|
|
6419
|
+
</dl>
|
|
6420
|
+
|
|
6421
|
+
#### ⚙️ Parameters
|
|
6422
|
+
|
|
6423
|
+
<dl>
|
|
6424
|
+
<dd>
|
|
6425
|
+
|
|
6426
|
+
<dl>
|
|
6427
|
+
<dd>
|
|
6428
|
+
|
|
6429
|
+
**id:** `string`
|
|
6430
|
+
|
|
6431
|
+
The ID of the webhook subscription.
|
|
6432
|
+
|
|
6433
|
+
Example: `"whes_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
6434
|
+
|
|
6435
|
+
</dd>
|
|
6436
|
+
</dl>
|
|
6437
|
+
|
|
6438
|
+
<dl>
|
|
6439
|
+
<dd>
|
|
6440
|
+
|
|
6441
|
+
**requestOptions:** `WebhookSubscriptionsClient.RequestOptions`
|
|
6442
|
+
|
|
6443
|
+
</dd>
|
|
6444
|
+
</dl>
|
|
6445
|
+
</dd>
|
|
6446
|
+
</dl>
|
|
6447
|
+
|
|
6448
|
+
|
|
6449
|
+
</dd>
|
|
6450
|
+
</dl>
|
|
6451
|
+
</details>
|
|
6452
|
+
|
|
6453
|
+
<details><summary><code>client.webhookSubscriptions.<a href="/src/api/resources/webhookSubscriptions/client/Client.ts">update</a>(id, { ...params }) -> Extend.WebhookSubscription</code></summary>
|
|
6454
|
+
<dl>
|
|
6455
|
+
<dd>
|
|
6456
|
+
|
|
6457
|
+
#### 📝 Description
|
|
6458
|
+
|
|
6459
|
+
<dl>
|
|
6460
|
+
<dd>
|
|
6461
|
+
|
|
6462
|
+
<dl>
|
|
6463
|
+
<dd>
|
|
6464
|
+
|
|
6465
|
+
Update the enabled events on a webhook subscription.
|
|
6466
|
+
</dd>
|
|
6467
|
+
</dl>
|
|
6468
|
+
</dd>
|
|
6469
|
+
</dl>
|
|
6470
|
+
|
|
6471
|
+
#### 🔌 Usage
|
|
6472
|
+
|
|
6473
|
+
<dl>
|
|
6474
|
+
<dd>
|
|
6475
|
+
|
|
6476
|
+
<dl>
|
|
6477
|
+
<dd>
|
|
6478
|
+
|
|
6479
|
+
```typescript
|
|
6480
|
+
await client.webhookSubscriptions.update("webhook_subscription_id_here", {
|
|
6481
|
+
enabledEvents: ["extract_run.processed"]
|
|
6482
|
+
});
|
|
6483
|
+
|
|
6484
|
+
```
|
|
6485
|
+
</dd>
|
|
6486
|
+
</dl>
|
|
6487
|
+
</dd>
|
|
6488
|
+
</dl>
|
|
6489
|
+
|
|
6490
|
+
#### ⚙️ Parameters
|
|
6491
|
+
|
|
6492
|
+
<dl>
|
|
6493
|
+
<dd>
|
|
6494
|
+
|
|
6495
|
+
<dl>
|
|
6496
|
+
<dd>
|
|
6497
|
+
|
|
6498
|
+
**id:** `string`
|
|
6499
|
+
|
|
6500
|
+
The ID of the webhook subscription to update.
|
|
6501
|
+
|
|
6502
|
+
Example: `"whes_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
6503
|
+
|
|
6504
|
+
</dd>
|
|
6505
|
+
</dl>
|
|
6506
|
+
|
|
6507
|
+
<dl>
|
|
6508
|
+
<dd>
|
|
6509
|
+
|
|
6510
|
+
**request:** `Extend.WebhookSubscriptionsUpdateRequest`
|
|
6511
|
+
|
|
6512
|
+
</dd>
|
|
6513
|
+
</dl>
|
|
6514
|
+
|
|
6515
|
+
<dl>
|
|
6516
|
+
<dd>
|
|
6517
|
+
|
|
6518
|
+
**requestOptions:** `WebhookSubscriptionsClient.RequestOptions`
|
|
6519
|
+
|
|
6520
|
+
</dd>
|
|
6521
|
+
</dl>
|
|
6522
|
+
</dd>
|
|
6523
|
+
</dl>
|
|
6524
|
+
|
|
6525
|
+
|
|
6526
|
+
</dd>
|
|
6527
|
+
</dl>
|
|
6528
|
+
</details>
|
|
6529
|
+
|
|
6530
|
+
<details><summary><code>client.webhookSubscriptions.<a href="/src/api/resources/webhookSubscriptions/client/Client.ts">delete</a>(id) -> Extend.WebhookSubscriptionsDeleteResponse</code></summary>
|
|
6531
|
+
<dl>
|
|
6532
|
+
<dd>
|
|
6533
|
+
|
|
6534
|
+
#### 📝 Description
|
|
6535
|
+
|
|
6536
|
+
<dl>
|
|
6537
|
+
<dd>
|
|
6538
|
+
|
|
6539
|
+
<dl>
|
|
6540
|
+
<dd>
|
|
6541
|
+
|
|
6542
|
+
Delete a webhook subscription. This operation is permanent and cannot be undone.
|
|
6543
|
+
</dd>
|
|
6544
|
+
</dl>
|
|
6545
|
+
</dd>
|
|
6546
|
+
</dl>
|
|
6547
|
+
|
|
6548
|
+
#### 🔌 Usage
|
|
6549
|
+
|
|
6550
|
+
<dl>
|
|
6551
|
+
<dd>
|
|
6552
|
+
|
|
6553
|
+
<dl>
|
|
6554
|
+
<dd>
|
|
6555
|
+
|
|
6556
|
+
```typescript
|
|
6557
|
+
await client.webhookSubscriptions.delete("webhook_subscription_id_here");
|
|
6558
|
+
|
|
6559
|
+
```
|
|
6560
|
+
</dd>
|
|
6561
|
+
</dl>
|
|
6562
|
+
</dd>
|
|
6563
|
+
</dl>
|
|
6564
|
+
|
|
6565
|
+
#### ⚙️ Parameters
|
|
6566
|
+
|
|
6567
|
+
<dl>
|
|
6568
|
+
<dd>
|
|
6569
|
+
|
|
6570
|
+
<dl>
|
|
6571
|
+
<dd>
|
|
6572
|
+
|
|
6573
|
+
**id:** `string`
|
|
6574
|
+
|
|
6575
|
+
The ID of the webhook subscription to delete.
|
|
6576
|
+
|
|
6577
|
+
Example: `"whes_Xj8mK2pL9nR4vT7qY5wZ"`
|
|
6578
|
+
|
|
6579
|
+
</dd>
|
|
6580
|
+
</dl>
|
|
6581
|
+
|
|
6582
|
+
<dl>
|
|
6583
|
+
<dd>
|
|
6584
|
+
|
|
6585
|
+
**requestOptions:** `WebhookSubscriptionsClient.RequestOptions`
|
|
6586
|
+
|
|
6587
|
+
</dd>
|
|
6588
|
+
</dl>
|
|
6589
|
+
</dd>
|
|
6590
|
+
</dl>
|
|
6591
|
+
|
|
6592
|
+
|
|
5732
6593
|
</dd>
|
|
5733
6594
|
</dl>
|
|
5734
6595
|
</details>
|