extend-ai 1.1.0 → 1.3.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.
Files changed (158) hide show
  1. package/BaseClient.js +2 -2
  2. package/Client.d.ts +70 -8
  3. package/Client.js +78 -12
  4. package/api/client/requests/ClassifyRequest.d.ts +16 -1
  5. package/api/client/requests/EditRequest.d.ts +7 -1
  6. package/api/client/requests/ExtractRequest.d.ts +20 -1
  7. package/api/client/requests/ParseRequest.d.ts +2 -1
  8. package/api/client/requests/SplitRequest.d.ts +16 -1
  9. package/api/resources/batchProcessorRun/client/Client.d.ts +1 -1
  10. package/api/resources/batchProcessorRun/client/Client.js +1 -1
  11. package/api/resources/classifierVersions/client/Client.d.ts +2 -1
  12. package/api/resources/classifierVersions/client/Client.js +2 -1
  13. package/api/resources/classifierVersions/client/requests/ClassifierVersionsCreateRequest.d.ts +2 -1
  14. package/api/resources/classifiers/client/Client.d.ts +19 -2
  15. package/api/resources/classifiers/client/Client.js +19 -2
  16. package/api/resources/classifiers/client/requests/ClassifiersCreateRequest.d.ts +16 -1
  17. package/api/resources/classifiers/client/requests/ClassifiersUpdateRequest.d.ts +3 -1
  18. package/api/resources/classifyRuns/client/Client.d.ts +4 -1
  19. package/api/resources/classifyRuns/client/Client.js +4 -1
  20. package/api/resources/classifyRuns/client/requests/ClassifyRunsCreateRequest.d.ts +4 -1
  21. package/api/resources/editRuns/client/Client.d.ts +7 -1
  22. package/api/resources/editRuns/client/Client.js +7 -1
  23. package/api/resources/editRuns/client/requests/EditRunsCreateRequest.d.ts +7 -1
  24. package/api/resources/evaluationSetItems/client/Client.d.ts +16 -4
  25. package/api/resources/evaluationSetItems/client/Client.js +16 -4
  26. package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsCreateRequest.d.ts +8 -2
  27. package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsUpdateRequest.d.ts +7 -1
  28. package/api/resources/evaluationSets/client/Client.d.ts +4 -3
  29. package/api/resources/evaluationSets/client/Client.js +4 -3
  30. package/api/resources/evaluationSets/client/requests/EvaluationSetsCreateRequest.d.ts +3 -2
  31. package/api/resources/extractRuns/client/Client.d.ts +4 -1
  32. package/api/resources/extractRuns/client/Client.js +4 -1
  33. package/api/resources/extractRuns/client/requests/ExtractRunsCreateRequest.d.ts +4 -1
  34. package/api/resources/extractorVersions/client/Client.d.ts +2 -1
  35. package/api/resources/extractorVersions/client/Client.js +2 -1
  36. package/api/resources/extractorVersions/client/requests/ExtractorVersionsCreateRequest.d.ts +2 -1
  37. package/api/resources/extractors/client/Client.d.ts +23 -2
  38. package/api/resources/extractors/client/Client.js +23 -2
  39. package/api/resources/extractors/client/requests/ExtractorsCreateRequest.d.ts +20 -1
  40. package/api/resources/extractors/client/requests/ExtractorsUpdateRequest.d.ts +3 -1
  41. package/api/resources/files/client/Client.d.ts +1 -1
  42. package/api/resources/files/client/Client.js +1 -1
  43. package/api/resources/index.d.ts +6 -0
  44. package/api/resources/index.js +7 -1
  45. package/api/resources/parseRuns/client/Client.d.ts +2 -1
  46. package/api/resources/parseRuns/client/Client.js +2 -1
  47. package/api/resources/parseRuns/client/requests/ParseRunsCreateRequest.d.ts +2 -1
  48. package/api/resources/processorRun/client/Client.d.ts +3 -3
  49. package/api/resources/processorRun/client/Client.js +3 -3
  50. package/api/resources/processorRun/client/requests/ProcessorRunCreateRequest.d.ts +1 -1
  51. package/api/resources/splitRuns/client/Client.d.ts +4 -1
  52. package/api/resources/splitRuns/client/Client.js +4 -1
  53. package/api/resources/splitRuns/client/requests/SplitRunsCreateRequest.d.ts +4 -1
  54. package/api/resources/splitterVersions/client/Client.d.ts +2 -1
  55. package/api/resources/splitterVersions/client/Client.js +2 -1
  56. package/api/resources/splitterVersions/client/requests/SplitterVersionsCreateRequest.d.ts +2 -1
  57. package/api/resources/splitters/client/Client.d.ts +19 -2
  58. package/api/resources/splitters/client/Client.js +19 -2
  59. package/api/resources/splitters/client/requests/SplittersCreateRequest.d.ts +16 -1
  60. package/api/resources/splitters/client/requests/SplittersUpdateRequest.d.ts +3 -1
  61. package/api/resources/webhookEndpoints/client/Client.d.ts +133 -0
  62. package/api/resources/webhookEndpoints/client/Client.js +440 -0
  63. package/api/resources/webhookEndpoints/client/index.d.ts +1 -0
  64. package/api/resources/webhookEndpoints/client/index.js +17 -0
  65. package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsCreateRequest.d.ts +21 -0
  66. package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsCreateRequest.js +3 -0
  67. package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsListRequest.d.ts +14 -0
  68. package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsListRequest.js +3 -0
  69. package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsUpdateRequest.d.ts +15 -0
  70. package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsUpdateRequest.js +3 -0
  71. package/api/resources/webhookEndpoints/client/requests/index.d.ts +3 -0
  72. package/api/resources/webhookEndpoints/client/requests/index.js +2 -0
  73. package/api/resources/webhookEndpoints/index.d.ts +2 -0
  74. package/api/resources/webhookEndpoints/index.js +18 -0
  75. package/api/resources/webhookEndpoints/types/WebhookEndpointsDeleteResponse.d.ts +4 -0
  76. package/api/resources/webhookEndpoints/types/WebhookEndpointsDeleteResponse.js +3 -0
  77. package/api/resources/webhookEndpoints/types/WebhookEndpointsListResponse.d.ts +6 -0
  78. package/api/resources/webhookEndpoints/types/WebhookEndpointsListResponse.js +3 -0
  79. package/api/resources/webhookEndpoints/types/index.d.ts +2 -0
  80. package/api/resources/webhookEndpoints/types/index.js +18 -0
  81. package/api/resources/webhookSubscriptions/client/Client.d.ts +133 -0
  82. package/api/resources/webhookSubscriptions/client/Client.js +444 -0
  83. package/api/resources/webhookSubscriptions/client/index.d.ts +1 -0
  84. package/api/resources/webhookSubscriptions/client/index.js +17 -0
  85. package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsCreateRequest.d.ts +19 -0
  86. package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsCreateRequest.js +3 -0
  87. package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsListRequest.d.ts +16 -0
  88. package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsListRequest.js +3 -0
  89. package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsUpdateRequest.d.ts +11 -0
  90. package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsUpdateRequest.js +3 -0
  91. package/api/resources/webhookSubscriptions/client/requests/index.d.ts +3 -0
  92. package/api/resources/webhookSubscriptions/client/requests/index.js +2 -0
  93. package/api/resources/webhookSubscriptions/index.d.ts +2 -0
  94. package/api/resources/webhookSubscriptions/index.js +18 -0
  95. package/api/resources/webhookSubscriptions/types/WebhookSubscriptionsDeleteResponse.d.ts +4 -0
  96. package/api/resources/webhookSubscriptions/types/WebhookSubscriptionsDeleteResponse.js +3 -0
  97. package/api/resources/webhookSubscriptions/types/WebhookSubscriptionsListResponse.d.ts +6 -0
  98. package/api/resources/webhookSubscriptions/types/WebhookSubscriptionsListResponse.js +3 -0
  99. package/api/resources/webhookSubscriptions/types/index.d.ts +2 -0
  100. package/api/resources/webhookSubscriptions/types/index.js +18 -0
  101. package/api/resources/workflowRuns/client/Client.d.ts +22 -6
  102. package/api/resources/workflowRuns/client/Client.js +22 -6
  103. package/api/resources/workflowRuns/client/requests/WorkflowRunsCreateBatchRequest.d.ts +12 -2
  104. package/api/resources/workflowRuns/client/requests/WorkflowRunsCreateRequest.d.ts +3 -3
  105. package/api/resources/workflowRuns/client/requests/WorkflowRunsListRequest.d.ts +1 -1
  106. package/api/resources/workflowRuns/client/requests/WorkflowRunsUpdateRequest.d.ts +7 -1
  107. package/api/resources/workflowRuns/types/WorkflowRunsCreateRequestFile.d.ts +1 -1
  108. package/api/types/ExtractAdvancedOptions.d.ts +1 -1
  109. package/api/types/ExtractAdvancedOptionsReviewAgent.d.ts +1 -1
  110. package/api/types/ExtractConfigJson.d.ts +1 -1
  111. package/api/types/ExtractOutputMetadataValue.d.ts +1 -1
  112. package/api/types/ExtractOverrideConfigJson.d.ts +1 -1
  113. package/api/types/ExtractRun.d.ts +10 -2
  114. package/api/types/ExtractorVersion.d.ts +6 -1
  115. package/api/types/LegacyClassificationAdvancedOptions.d.ts +1 -1
  116. package/api/types/LegacyClassificationConfig.d.ts +2 -2
  117. package/api/types/LegacyClassificationConfigBaseProcessor.d.ts +1 -1
  118. package/api/types/LegacyClassificationConfigBaseProcessor.js +1 -1
  119. package/api/types/LegacyDocumentProcessorRunCredits.d.ts +2 -2
  120. package/api/types/LegacyExtractionAdvancedOptions.d.ts +2 -2
  121. package/api/types/LegacyExtractionAdvancedOptionsReviewAgent.d.ts +1 -1
  122. package/api/types/LegacyExtractionConfig.d.ts +3 -3
  123. package/api/types/LegacyExtractionConfigBaseProcessor.d.ts +1 -1
  124. package/api/types/LegacyExtractionConfigBaseProcessor.js +1 -1
  125. package/api/types/LegacyJsonOutputMetadataValue.d.ts +1 -1
  126. package/api/types/LegacySplitterAdvancedOptions.d.ts +1 -1
  127. package/api/types/LegacySplitterConfig.d.ts +2 -2
  128. package/api/types/LegacySplitterConfigBaseProcessor.d.ts +1 -1
  129. package/api/types/LegacySplitterConfigBaseProcessor.js +1 -1
  130. package/api/types/ParseConfig.d.ts +3 -1
  131. package/api/types/ParseConfigTarget.d.ts +1 -1
  132. package/api/types/ParseConfigTarget.js +1 -1
  133. package/api/types/WebhookAdvancedOptions.d.ts +9 -0
  134. package/api/types/WebhookAdvancedOptions.js +3 -0
  135. package/api/types/WebhookEndpoint.d.ts +18 -0
  136. package/api/types/WebhookEndpoint.js +3 -0
  137. package/api/types/WebhookEndpointCreate.d.ts +27 -0
  138. package/api/types/WebhookEndpointCreate.js +3 -0
  139. package/api/types/WebhookEndpointEventType.d.ts +32 -0
  140. package/api/types/WebhookEndpointEventType.js +35 -0
  141. package/api/types/WebhookEndpointStatus.d.ts +6 -0
  142. package/api/types/WebhookEndpointStatus.js +9 -0
  143. package/api/types/WebhookPayloadFormat.d.ts +11 -0
  144. package/api/types/WebhookPayloadFormat.js +14 -0
  145. package/api/types/WebhookPayloadOptions.d.ts +9 -0
  146. package/api/types/WebhookPayloadOptions.js +3 -0
  147. package/api/types/WebhookSubscription.d.ts +15 -0
  148. package/api/types/WebhookSubscription.js +3 -0
  149. package/api/types/WebhookSubscriptionEventType.d.ts +23 -0
  150. package/api/types/WebhookSubscriptionEventType.js +26 -0
  151. package/api/types/WebhookSubscriptionResourceType.d.ts +8 -0
  152. package/api/types/WebhookSubscriptionResourceType.js +11 -0
  153. package/api/types/index.d.ts +10 -0
  154. package/api/types/index.js +10 -0
  155. package/package.json +1 -1
  156. package/reference.md +897 -40
  157. package/version.d.ts +1 -1
  158. 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: "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: "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/extracting/extract).
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: "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/classifying/classify).
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: "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/split).
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,23 @@ 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
+ }, {
375
+ id: "receipt",
376
+ type: "receipt",
377
+ description: "A receipt confirming payment"
378
+ }, {
379
+ id: "other",
380
+ type: "other",
381
+ description: "Any other document type"
382
+ }]
383
+ },
328
384
  file: {
329
- url: "url"
385
+ url: "https://example.com/multi-document.pdf"
330
386
  }
331
387
  });
332
388
 
@@ -588,7 +644,7 @@ Example: `"file_xK9mLPqRtN3vS8wF5hB2cQ"`
588
644
 
589
645
  Upload and create a new file in Extend.
590
646
 
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/run-workflow), [creating evaluation set items](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/evaluation/bulk-create-evaluation-set-items), [parsing](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/parse/parse-file), etc.
647
+ 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
648
 
593
649
  If an uploaded file is detected as a Word or PowerPoint document, it will be automatically converted to a PDF.
594
650
 
@@ -679,7 +735,8 @@ The request returns immediately with a `PROCESSING` status. Use webhooks or poll
679
735
  ```typescript
680
736
  await client.parseRuns.create({
681
737
  file: {
682
- url: "url"
738
+ url: "https://example.com/bank_statement.pdf",
739
+ name: "bank_statement.pdf"
683
740
  }
684
741
  });
685
742
 
@@ -897,7 +954,13 @@ The request returns immediately with a `PROCESSING` status. Use webhooks or poll
897
954
  ```typescript
898
955
  await client.editRuns.create({
899
956
  file: {
900
- url: "url"
957
+ url: "https://example.com/form.pdf"
958
+ },
959
+ config: {
960
+ instructions: "Fill out the form with the provided data",
961
+ advancedOptions: {
962
+ flattenPdf: true
963
+ }
901
964
  }
902
965
  });
903
966
 
@@ -1171,8 +1234,11 @@ The request returns immediately with a `PROCESSING` status. Use webhooks or poll
1171
1234
 
1172
1235
  ```typescript
1173
1236
  await client.extractRuns.create({
1237
+ extractor: {
1238
+ id: "ex_1234567890"
1239
+ },
1174
1240
  file: {
1175
- url: "url"
1241
+ url: "https://example.com/invoice.pdf"
1176
1242
  }
1177
1243
  });
1178
1244
 
@@ -1509,7 +1575,26 @@ Create a new extractor.
1509
1575
 
1510
1576
  ```typescript
1511
1577
  await client.extractors.create({
1512
- name: "name"
1578
+ name: "Invoice Extractor",
1579
+ config: {
1580
+ schema: {
1581
+ "type": "object",
1582
+ "properties": {
1583
+ "vendor_name": {
1584
+ "type": "string",
1585
+ "description": "The name of the vendor"
1586
+ },
1587
+ "invoice_number": {
1588
+ "type": "string",
1589
+ "description": "The invoice number"
1590
+ },
1591
+ "total_amount": {
1592
+ "type": "number",
1593
+ "description": "The total amount due"
1594
+ }
1595
+ }
1596
+ }
1597
+ }
1513
1598
  });
1514
1599
 
1515
1600
  ```
@@ -1640,7 +1725,9 @@ Update an existing extractor.
1640
1725
  <dd>
1641
1726
 
1642
1727
  ```typescript
1643
- await client.extractors.update("extractor_id_here");
1728
+ await client.extractors.update("extractor_id_here", {
1729
+ name: "Invoice Extractor v2"
1730
+ });
1644
1731
 
1645
1732
  ```
1646
1733
  </dd>
@@ -1798,7 +1885,8 @@ Publishing a new version does not automatically update existing workflows using
1798
1885
 
1799
1886
  ```typescript
1800
1887
  await client.extractorVersions.create("extractor_id_here", {
1801
- releaseType: "major"
1888
+ releaseType: "minor",
1889
+ description: "Updated extraction rules for better accuracy"
1802
1890
  });
1803
1891
 
1804
1892
  ```
@@ -2024,8 +2112,11 @@ The request returns immediately with a `PROCESSING` status. Use webhooks or poll
2024
2112
 
2025
2113
  ```typescript
2026
2114
  await client.classifyRuns.create({
2115
+ classifier: {
2116
+ id: "cl_1234567890"
2117
+ },
2027
2118
  file: {
2028
- url: "url"
2119
+ url: "https://example.com/document.pdf"
2029
2120
  }
2030
2121
  });
2031
2122
 
@@ -2362,7 +2453,22 @@ Create a new classifier.
2362
2453
 
2363
2454
  ```typescript
2364
2455
  await client.classifiers.create({
2365
- name: "name"
2456
+ name: "Document Classifier",
2457
+ config: {
2458
+ classifications: [{
2459
+ id: "invoice",
2460
+ type: "invoice",
2461
+ description: "An invoice or bill for goods or services"
2462
+ }, {
2463
+ id: "receipt",
2464
+ type: "receipt",
2465
+ description: "A receipt confirming payment"
2466
+ }, {
2467
+ id: "other",
2468
+ type: "other",
2469
+ description: "Any other document type"
2470
+ }]
2471
+ }
2366
2472
  });
2367
2473
 
2368
2474
  ```
@@ -2493,7 +2599,9 @@ Update an existing classifier.
2493
2599
  <dd>
2494
2600
 
2495
2601
  ```typescript
2496
- await client.classifiers.update("classifier_id_here");
2602
+ await client.classifiers.update("classifier_id_here", {
2603
+ name: "Document Classifier v2"
2604
+ });
2497
2605
 
2498
2606
  ```
2499
2607
  </dd>
@@ -2651,7 +2759,8 @@ Publishing a new version does not automatically update existing workflows using
2651
2759
 
2652
2760
  ```typescript
2653
2761
  await client.classifierVersions.create("classifier_id_here", {
2654
- releaseType: "major"
2762
+ releaseType: "minor",
2763
+ description: "Added new document classification type"
2655
2764
  });
2656
2765
 
2657
2766
  ```
@@ -2877,8 +2986,11 @@ The request returns immediately with a `PROCESSING` status. Use webhooks or poll
2877
2986
 
2878
2987
  ```typescript
2879
2988
  await client.splitRuns.create({
2989
+ splitter: {
2990
+ id: "spl_1234567890"
2991
+ },
2880
2992
  file: {
2881
- url: "url"
2993
+ url: "https://example.com/multi-document.pdf"
2882
2994
  }
2883
2995
  });
2884
2996
 
@@ -3215,7 +3327,22 @@ Create a new splitter.
3215
3327
 
3216
3328
  ```typescript
3217
3329
  await client.splitters.create({
3218
- name: "name"
3330
+ name: "Document Splitter",
3331
+ config: {
3332
+ splitClassifications: [{
3333
+ id: "invoice",
3334
+ type: "invoice",
3335
+ description: "An invoice or bill for goods or services"
3336
+ }, {
3337
+ id: "receipt",
3338
+ type: "receipt",
3339
+ description: "A receipt confirming payment"
3340
+ }, {
3341
+ id: "other",
3342
+ type: "other",
3343
+ description: "Any other document type"
3344
+ }]
3345
+ }
3219
3346
  });
3220
3347
 
3221
3348
  ```
@@ -3346,7 +3473,9 @@ Update an existing splitter.
3346
3473
  <dd>
3347
3474
 
3348
3475
  ```typescript
3349
- await client.splitters.update("splitter_id_here");
3476
+ await client.splitters.update("splitter_id_here", {
3477
+ name: "Document Splitter v2"
3478
+ });
3350
3479
 
3351
3480
  ```
3352
3481
  </dd>
@@ -3504,7 +3633,8 @@ Publishing a new version does not automatically update existing workflows using
3504
3633
 
3505
3634
  ```typescript
3506
3635
  await client.splitterVersions.create("splitter_id_here", {
3507
- releaseType: "major"
3636
+ releaseType: "minor",
3637
+ description: "Improved split boundary detection"
3508
3638
  });
3509
3639
 
3510
3640
  ```
@@ -3797,10 +3927,10 @@ The request returns immediately with a `PROCESSING` status. Use webhooks or poll
3797
3927
  ```typescript
3798
3928
  await client.workflowRuns.create({
3799
3929
  workflow: {
3800
- id: "workflow_BMdfq_yWM3sT-ZzvCnA3f"
3930
+ id: "wf_1234567890"
3801
3931
  },
3802
3932
  file: {
3803
- url: "url"
3933
+ url: "https://example.com/invoice.pdf"
3804
3934
  }
3805
3935
  });
3806
3936
 
@@ -3932,7 +4062,13 @@ You can update the name and metadata of an in progress WorkflowRun at any time u
3932
4062
  <dd>
3933
4063
 
3934
4064
  ```typescript
3935
- await client.workflowRuns.update("workflow_run_id_here");
4065
+ await client.workflowRuns.update("workflow_run_id_here", {
4066
+ name: "Invoice #12345",
4067
+ metadata: {
4068
+ "customerId": "cust_abc123",
4069
+ "source": "email-inbox"
4070
+ }
4071
+ });
3936
4072
 
3937
4073
  ```
3938
4074
  </dd>
@@ -4132,7 +4268,7 @@ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
4132
4268
 
4133
4269
  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
4270
 
4135
- Unlike the single [Run Workflow](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/workflow/run-workflow) endpoint which returns the details of the created workflow runs immediately, this batch endpoint returns a `batchId`.
4271
+ 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
4272
 
4137
4273
  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
4274
 
@@ -4159,11 +4295,21 @@ Upon successful submission, the endpoint returns a `batchId`. The individual wor
4159
4295
  ```typescript
4160
4296
  await client.workflowRuns.createBatch({
4161
4297
  workflow: {
4162
- id: "workflow_BMdfq_yWM3sT-ZzvCnA3f"
4298
+ id: "wf_1234567890"
4163
4299
  },
4164
4300
  inputs: [{
4165
4301
  file: {
4166
- url: "url"
4302
+ url: "https://example.com/invoice1.pdf"
4303
+ },
4304
+ metadata: {
4305
+ "customerId": "cust_abc123"
4306
+ }
4307
+ }, {
4308
+ file: {
4309
+ url: "https://example.com/invoice2.pdf"
4310
+ },
4311
+ metadata: {
4312
+ "customerId": "cust_def456"
4167
4313
  }
4168
4314
  }]
4169
4315
  });
@@ -4287,8 +4433,8 @@ Run processors (extraction, classification, splitting, etc.) on a given document
4287
4433
  - **Synchronous**: Set `sync: true` to wait for completion and get final results in the response (5-minute timeout).
4288
4434
 
4289
4435
  **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/2025-04-21/developers/api-reference/processor-endpoints/get-processor-run) for updates on the status of the processor run.
4436
+ - 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.
4437
+ - 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
4438
  </dd>
4293
4439
  </dl>
4294
4440
  </dd>
@@ -4355,7 +4501,7 @@ await client.processorRun.create({
4355
4501
 
4356
4502
  Retrieve details about a specific processor run, including its status, outputs, and any edits made during review.
4357
4503
 
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/2025-04-21/developers/api-reference/processor-endpoints/run-processor) endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.
4504
+ 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
4505
  </dd>
4360
4506
  </dl>
4361
4507
  </dd>
@@ -4997,7 +5143,7 @@ Example: `"exv_QYk6jgHA_8CsO8rVWhyNC"`
4997
5143
 
4998
5144
  Retrieve details about a batch processor run, including evaluation runs.
4999
5145
 
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.
5146
+ **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
5147
  </dd>
5002
5148
  </dl>
5003
5149
  </dd>
@@ -5133,7 +5279,7 @@ await client.evaluationSets.list({
5133
5279
 
5134
5280
  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
5281
 
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.
5282
+ 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
5283
  </dd>
5138
5284
  </dl>
5139
5285
  </dd>
@@ -5149,8 +5295,9 @@ Note: It is not necessary to create an evaluation set via API. You can also crea
5149
5295
 
5150
5296
  ```typescript
5151
5297
  await client.evaluationSets.create({
5152
- name: "My Evaluation Set",
5153
- entityId: "entity_id_here"
5298
+ name: "Invoice Processing Test Set",
5299
+ description: "Q4 vendor invoices for accuracy testing",
5300
+ entityId: "ex_1234567890"
5154
5301
  });
5155
5302
 
5156
5303
  ```
@@ -5350,7 +5497,7 @@ Evaluation set items are the individual files and expected outputs that are used
5350
5497
 
5351
5498
  **Limit:** You can create up to 100 items at a time.
5352
5499
 
5353
- Learn more about how to create evaluation set items in the [Evaluation Sets](https://docs.extend.ai/product/evaluation/overview) product page.
5500
+ 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
5501
  </dd>
5355
5502
  </dl>
5356
5503
  </dd>
@@ -5367,8 +5514,14 @@ Learn more about how to create evaluation set items in the [Evaluation Sets](htt
5367
5514
  ```typescript
5368
5515
  await client.evaluationSetItems.create("evaluation_set_id_here", {
5369
5516
  items: [{
5370
- fileId: "file_id_here",
5371
- expectedOutput: {}
5517
+ fileId: "file_xK9mLPqRtN3vS8wF5hB2cQ",
5518
+ expectedOutput: {
5519
+ value: {
5520
+ "vendor_name": "Acme Corp",
5521
+ "invoice_number": "INV-001",
5522
+ "total_amount": 1500
5523
+ }
5524
+ }
5372
5525
  }]
5373
5526
  });
5374
5527
 
@@ -5525,7 +5678,13 @@ If you need to change the expected output for a given evaluation set item, you c
5525
5678
 
5526
5679
  ```typescript
5527
5680
  await client.evaluationSetItems.update("evaluation_set_id_here", "evaluation_set_item_id_here", {
5528
- expectedOutput: {}
5681
+ expectedOutput: {
5682
+ value: {
5683
+ "vendor_name": "Acme Corp",
5684
+ "invoice_number": "INV-001",
5685
+ "total_amount": 1750
5686
+ }
5687
+ }
5529
5688
  });
5530
5689
 
5531
5690
  ```
@@ -5729,6 +5888,704 @@ Example: `"evr_Xj8mK2pL9nR4vT7qY5wZ"`
5729
5888
  </dl>
5730
5889
 
5731
5890
 
5891
+ </dd>
5892
+ </dl>
5893
+ </details>
5894
+
5895
+ ## WebhookEndpoints
5896
+ <details><summary><code>client.webhookEndpoints.<a href="/src/api/resources/webhookEndpoints/client/Client.ts">list</a>({ ...params }) -> Extend.WebhookEndpointsListResponse</code></summary>
5897
+ <dl>
5898
+ <dd>
5899
+
5900
+ #### 📝 Description
5901
+
5902
+ <dl>
5903
+ <dd>
5904
+
5905
+ <dl>
5906
+ <dd>
5907
+
5908
+ List all webhook endpoints.
5909
+ </dd>
5910
+ </dl>
5911
+ </dd>
5912
+ </dl>
5913
+
5914
+ #### 🔌 Usage
5915
+
5916
+ <dl>
5917
+ <dd>
5918
+
5919
+ <dl>
5920
+ <dd>
5921
+
5922
+ ```typescript
5923
+ await client.webhookEndpoints.list({
5924
+ nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
5925
+ });
5926
+
5927
+ ```
5928
+ </dd>
5929
+ </dl>
5930
+ </dd>
5931
+ </dl>
5932
+
5933
+ #### ⚙️ Parameters
5934
+
5935
+ <dl>
5936
+ <dd>
5937
+
5938
+ <dl>
5939
+ <dd>
5940
+
5941
+ **request:** `Extend.WebhookEndpointsListRequest`
5942
+
5943
+ </dd>
5944
+ </dl>
5945
+
5946
+ <dl>
5947
+ <dd>
5948
+
5949
+ **requestOptions:** `WebhookEndpointsClient.RequestOptions`
5950
+
5951
+ </dd>
5952
+ </dl>
5953
+ </dd>
5954
+ </dl>
5955
+
5956
+
5957
+ </dd>
5958
+ </dl>
5959
+ </details>
5960
+
5961
+ <details><summary><code>client.webhookEndpoints.<a href="/src/api/resources/webhookEndpoints/client/Client.ts">create</a>({ ...params }) -> Extend.WebhookEndpointCreate</code></summary>
5962
+ <dl>
5963
+ <dd>
5964
+
5965
+ #### 📝 Description
5966
+
5967
+ <dl>
5968
+ <dd>
5969
+
5970
+ <dl>
5971
+ <dd>
5972
+
5973
+ Create a new webhook endpoint. The response includes a `signingSecret` that is only returned once — store it securely for verifying webhook signatures.
5974
+
5975
+ 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.
5976
+
5977
+ 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.
5978
+ </dd>
5979
+ </dl>
5980
+ </dd>
5981
+ </dl>
5982
+
5983
+ #### 🔌 Usage
5984
+
5985
+ <dl>
5986
+ <dd>
5987
+
5988
+ <dl>
5989
+ <dd>
5990
+
5991
+ ```typescript
5992
+ await client.webhookEndpoints.create({
5993
+ url: "https://example.com/webhooks",
5994
+ name: "Production webhook",
5995
+ enabledEvents: ["extract_run.processed", "workflow.created"],
5996
+ apiVersion: "2026-02-09"
5997
+ });
5998
+
5999
+ ```
6000
+ </dd>
6001
+ </dl>
6002
+ </dd>
6003
+ </dl>
6004
+
6005
+ #### ⚙️ Parameters
6006
+
6007
+ <dl>
6008
+ <dd>
6009
+
6010
+ <dl>
6011
+ <dd>
6012
+
6013
+ **request:** `Extend.WebhookEndpointsCreateRequest`
6014
+
6015
+ </dd>
6016
+ </dl>
6017
+
6018
+ <dl>
6019
+ <dd>
6020
+
6021
+ **requestOptions:** `WebhookEndpointsClient.RequestOptions`
6022
+
6023
+ </dd>
6024
+ </dl>
6025
+ </dd>
6026
+ </dl>
6027
+
6028
+
6029
+ </dd>
6030
+ </dl>
6031
+ </details>
6032
+
6033
+ <details><summary><code>client.webhookEndpoints.<a href="/src/api/resources/webhookEndpoints/client/Client.ts">retrieve</a>(id) -> Extend.WebhookEndpoint</code></summary>
6034
+ <dl>
6035
+ <dd>
6036
+
6037
+ #### 📝 Description
6038
+
6039
+ <dl>
6040
+ <dd>
6041
+
6042
+ <dl>
6043
+ <dd>
6044
+
6045
+ Retrieve a webhook endpoint by ID.
6046
+ </dd>
6047
+ </dl>
6048
+ </dd>
6049
+ </dl>
6050
+
6051
+ #### 🔌 Usage
6052
+
6053
+ <dl>
6054
+ <dd>
6055
+
6056
+ <dl>
6057
+ <dd>
6058
+
6059
+ ```typescript
6060
+ await client.webhookEndpoints.retrieve("webhook_endpoint_id_here");
6061
+
6062
+ ```
6063
+ </dd>
6064
+ </dl>
6065
+ </dd>
6066
+ </dl>
6067
+
6068
+ #### ⚙️ Parameters
6069
+
6070
+ <dl>
6071
+ <dd>
6072
+
6073
+ <dl>
6074
+ <dd>
6075
+
6076
+ **id:** `string`
6077
+
6078
+ The ID of the webhook endpoint.
6079
+
6080
+ Example: `"wh_Xj8mK2pL9nR4vT7qY5wZ"`
6081
+
6082
+ </dd>
6083
+ </dl>
6084
+
6085
+ <dl>
6086
+ <dd>
6087
+
6088
+ **requestOptions:** `WebhookEndpointsClient.RequestOptions`
6089
+
6090
+ </dd>
6091
+ </dl>
6092
+ </dd>
6093
+ </dl>
6094
+
6095
+
6096
+ </dd>
6097
+ </dl>
6098
+ </details>
6099
+
6100
+ <details><summary><code>client.webhookEndpoints.<a href="/src/api/resources/webhookEndpoints/client/Client.ts">update</a>(id, { ...params }) -> Extend.WebhookEndpoint</code></summary>
6101
+ <dl>
6102
+ <dd>
6103
+
6104
+ #### 📝 Description
6105
+
6106
+ <dl>
6107
+ <dd>
6108
+
6109
+ <dl>
6110
+ <dd>
6111
+
6112
+ Update a webhook endpoint. Only the fields you include in the request body will be updated; omitted fields remain unchanged.
6113
+
6114
+ The `apiVersion` of a webhook endpoint cannot be changed after creation.
6115
+ </dd>
6116
+ </dl>
6117
+ </dd>
6118
+ </dl>
6119
+
6120
+ #### 🔌 Usage
6121
+
6122
+ <dl>
6123
+ <dd>
6124
+
6125
+ <dl>
6126
+ <dd>
6127
+
6128
+ ```typescript
6129
+ await client.webhookEndpoints.update("webhook_endpoint_id_here");
6130
+
6131
+ ```
6132
+ </dd>
6133
+ </dl>
6134
+ </dd>
6135
+ </dl>
6136
+
6137
+ #### ⚙️ Parameters
6138
+
6139
+ <dl>
6140
+ <dd>
6141
+
6142
+ <dl>
6143
+ <dd>
6144
+
6145
+ **id:** `string`
6146
+
6147
+ The ID of the webhook endpoint to update.
6148
+
6149
+ Example: `"wh_Xj8mK2pL9nR4vT7qY5wZ"`
6150
+
6151
+ </dd>
6152
+ </dl>
6153
+
6154
+ <dl>
6155
+ <dd>
6156
+
6157
+ **request:** `Extend.WebhookEndpointsUpdateRequest`
6158
+
6159
+ </dd>
6160
+ </dl>
6161
+
6162
+ <dl>
6163
+ <dd>
6164
+
6165
+ **requestOptions:** `WebhookEndpointsClient.RequestOptions`
6166
+
6167
+ </dd>
6168
+ </dl>
6169
+ </dd>
6170
+ </dl>
6171
+
6172
+
6173
+ </dd>
6174
+ </dl>
6175
+ </details>
6176
+
6177
+ <details><summary><code>client.webhookEndpoints.<a href="/src/api/resources/webhookEndpoints/client/Client.ts">delete</a>(id) -> Extend.WebhookEndpointsDeleteResponse</code></summary>
6178
+ <dl>
6179
+ <dd>
6180
+
6181
+ #### 📝 Description
6182
+
6183
+ <dl>
6184
+ <dd>
6185
+
6186
+ <dl>
6187
+ <dd>
6188
+
6189
+ Delete a webhook endpoint and all of its subscriptions. This operation is permanent and cannot be undone.
6190
+ </dd>
6191
+ </dl>
6192
+ </dd>
6193
+ </dl>
6194
+
6195
+ #### 🔌 Usage
6196
+
6197
+ <dl>
6198
+ <dd>
6199
+
6200
+ <dl>
6201
+ <dd>
6202
+
6203
+ ```typescript
6204
+ await client.webhookEndpoints.delete("webhook_endpoint_id_here");
6205
+
6206
+ ```
6207
+ </dd>
6208
+ </dl>
6209
+ </dd>
6210
+ </dl>
6211
+
6212
+ #### ⚙️ Parameters
6213
+
6214
+ <dl>
6215
+ <dd>
6216
+
6217
+ <dl>
6218
+ <dd>
6219
+
6220
+ **id:** `string`
6221
+
6222
+ The ID of the webhook endpoint to delete.
6223
+
6224
+ Example: `"wh_Xj8mK2pL9nR4vT7qY5wZ"`
6225
+
6226
+ </dd>
6227
+ </dl>
6228
+
6229
+ <dl>
6230
+ <dd>
6231
+
6232
+ **requestOptions:** `WebhookEndpointsClient.RequestOptions`
6233
+
6234
+ </dd>
6235
+ </dl>
6236
+ </dd>
6237
+ </dl>
6238
+
6239
+
6240
+ </dd>
6241
+ </dl>
6242
+ </details>
6243
+
6244
+ ## WebhookSubscriptions
6245
+ <details><summary><code>client.webhookSubscriptions.<a href="/src/api/resources/webhookSubscriptions/client/Client.ts">list</a>({ ...params }) -> Extend.WebhookSubscriptionsListResponse</code></summary>
6246
+ <dl>
6247
+ <dd>
6248
+
6249
+ #### 📝 Description
6250
+
6251
+ <dl>
6252
+ <dd>
6253
+
6254
+ <dl>
6255
+ <dd>
6256
+
6257
+ 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.
6258
+ </dd>
6259
+ </dl>
6260
+ </dd>
6261
+ </dl>
6262
+
6263
+ #### 🔌 Usage
6264
+
6265
+ <dl>
6266
+ <dd>
6267
+
6268
+ <dl>
6269
+ <dd>
6270
+
6271
+ ```typescript
6272
+ await client.webhookSubscriptions.list({
6273
+ nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
6274
+ });
6275
+
6276
+ ```
6277
+ </dd>
6278
+ </dl>
6279
+ </dd>
6280
+ </dl>
6281
+
6282
+ #### ⚙️ Parameters
6283
+
6284
+ <dl>
6285
+ <dd>
6286
+
6287
+ <dl>
6288
+ <dd>
6289
+
6290
+ **request:** `Extend.WebhookSubscriptionsListRequest`
6291
+
6292
+ </dd>
6293
+ </dl>
6294
+
6295
+ <dl>
6296
+ <dd>
6297
+
6298
+ **requestOptions:** `WebhookSubscriptionsClient.RequestOptions`
6299
+
6300
+ </dd>
6301
+ </dl>
6302
+ </dd>
6303
+ </dl>
6304
+
6305
+
6306
+ </dd>
6307
+ </dl>
6308
+ </details>
6309
+
6310
+ <details><summary><code>client.webhookSubscriptions.<a href="/src/api/resources/webhookSubscriptions/client/Client.ts">create</a>({ ...params }) -> Extend.WebhookSubscription</code></summary>
6311
+ <dl>
6312
+ <dd>
6313
+
6314
+ #### 📝 Description
6315
+
6316
+ <dl>
6317
+ <dd>
6318
+
6319
+ <dl>
6320
+ <dd>
6321
+
6322
+ Create a resource-scoped webhook subscription on an existing webhook endpoint.
6323
+
6324
+ 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`.
6325
+
6326
+ If a subscription already exists for the same endpoint and resource, it will be updated with the new `enabledEvents` instead of creating a duplicate.
6327
+ </dd>
6328
+ </dl>
6329
+ </dd>
6330
+ </dl>
6331
+
6332
+ #### 🔌 Usage
6333
+
6334
+ <dl>
6335
+ <dd>
6336
+
6337
+ <dl>
6338
+ <dd>
6339
+
6340
+ ```typescript
6341
+ await client.webhookSubscriptions.create({
6342
+ webhookEndpointId: "wh_Xj8mK2pL9nR4vT7qY5wZ",
6343
+ resourceType: "extractor",
6344
+ resourceId: "ex_Xj8mK2pL9nR4vT7qY5wZ",
6345
+ enabledEvents: ["extract_run.processed", "extract_run.failed"]
6346
+ });
6347
+
6348
+ ```
6349
+ </dd>
6350
+ </dl>
6351
+ </dd>
6352
+ </dl>
6353
+
6354
+ #### ⚙️ Parameters
6355
+
6356
+ <dl>
6357
+ <dd>
6358
+
6359
+ <dl>
6360
+ <dd>
6361
+
6362
+ **request:** `Extend.WebhookSubscriptionsCreateRequest`
6363
+
6364
+ </dd>
6365
+ </dl>
6366
+
6367
+ <dl>
6368
+ <dd>
6369
+
6370
+ **requestOptions:** `WebhookSubscriptionsClient.RequestOptions`
6371
+
6372
+ </dd>
6373
+ </dl>
6374
+ </dd>
6375
+ </dl>
6376
+
6377
+
6378
+ </dd>
6379
+ </dl>
6380
+ </details>
6381
+
6382
+ <details><summary><code>client.webhookSubscriptions.<a href="/src/api/resources/webhookSubscriptions/client/Client.ts">retrieve</a>(id) -> Extend.WebhookSubscription</code></summary>
6383
+ <dl>
6384
+ <dd>
6385
+
6386
+ #### 📝 Description
6387
+
6388
+ <dl>
6389
+ <dd>
6390
+
6391
+ <dl>
6392
+ <dd>
6393
+
6394
+ Retrieve a webhook subscription by ID.
6395
+ </dd>
6396
+ </dl>
6397
+ </dd>
6398
+ </dl>
6399
+
6400
+ #### 🔌 Usage
6401
+
6402
+ <dl>
6403
+ <dd>
6404
+
6405
+ <dl>
6406
+ <dd>
6407
+
6408
+ ```typescript
6409
+ await client.webhookSubscriptions.retrieve("webhook_subscription_id_here");
6410
+
6411
+ ```
6412
+ </dd>
6413
+ </dl>
6414
+ </dd>
6415
+ </dl>
6416
+
6417
+ #### ⚙️ Parameters
6418
+
6419
+ <dl>
6420
+ <dd>
6421
+
6422
+ <dl>
6423
+ <dd>
6424
+
6425
+ **id:** `string`
6426
+
6427
+ The ID of the webhook subscription.
6428
+
6429
+ Example: `"whes_Xj8mK2pL9nR4vT7qY5wZ"`
6430
+
6431
+ </dd>
6432
+ </dl>
6433
+
6434
+ <dl>
6435
+ <dd>
6436
+
6437
+ **requestOptions:** `WebhookSubscriptionsClient.RequestOptions`
6438
+
6439
+ </dd>
6440
+ </dl>
6441
+ </dd>
6442
+ </dl>
6443
+
6444
+
6445
+ </dd>
6446
+ </dl>
6447
+ </details>
6448
+
6449
+ <details><summary><code>client.webhookSubscriptions.<a href="/src/api/resources/webhookSubscriptions/client/Client.ts">update</a>(id, { ...params }) -> Extend.WebhookSubscription</code></summary>
6450
+ <dl>
6451
+ <dd>
6452
+
6453
+ #### 📝 Description
6454
+
6455
+ <dl>
6456
+ <dd>
6457
+
6458
+ <dl>
6459
+ <dd>
6460
+
6461
+ Update the enabled events on a webhook subscription.
6462
+ </dd>
6463
+ </dl>
6464
+ </dd>
6465
+ </dl>
6466
+
6467
+ #### 🔌 Usage
6468
+
6469
+ <dl>
6470
+ <dd>
6471
+
6472
+ <dl>
6473
+ <dd>
6474
+
6475
+ ```typescript
6476
+ await client.webhookSubscriptions.update("webhook_subscription_id_here", {
6477
+ enabledEvents: ["extract_run.processed"]
6478
+ });
6479
+
6480
+ ```
6481
+ </dd>
6482
+ </dl>
6483
+ </dd>
6484
+ </dl>
6485
+
6486
+ #### ⚙️ Parameters
6487
+
6488
+ <dl>
6489
+ <dd>
6490
+
6491
+ <dl>
6492
+ <dd>
6493
+
6494
+ **id:** `string`
6495
+
6496
+ The ID of the webhook subscription to update.
6497
+
6498
+ Example: `"whes_Xj8mK2pL9nR4vT7qY5wZ"`
6499
+
6500
+ </dd>
6501
+ </dl>
6502
+
6503
+ <dl>
6504
+ <dd>
6505
+
6506
+ **request:** `Extend.WebhookSubscriptionsUpdateRequest`
6507
+
6508
+ </dd>
6509
+ </dl>
6510
+
6511
+ <dl>
6512
+ <dd>
6513
+
6514
+ **requestOptions:** `WebhookSubscriptionsClient.RequestOptions`
6515
+
6516
+ </dd>
6517
+ </dl>
6518
+ </dd>
6519
+ </dl>
6520
+
6521
+
6522
+ </dd>
6523
+ </dl>
6524
+ </details>
6525
+
6526
+ <details><summary><code>client.webhookSubscriptions.<a href="/src/api/resources/webhookSubscriptions/client/Client.ts">delete</a>(id) -> Extend.WebhookSubscriptionsDeleteResponse</code></summary>
6527
+ <dl>
6528
+ <dd>
6529
+
6530
+ #### 📝 Description
6531
+
6532
+ <dl>
6533
+ <dd>
6534
+
6535
+ <dl>
6536
+ <dd>
6537
+
6538
+ Delete a webhook subscription. This operation is permanent and cannot be undone.
6539
+ </dd>
6540
+ </dl>
6541
+ </dd>
6542
+ </dl>
6543
+
6544
+ #### 🔌 Usage
6545
+
6546
+ <dl>
6547
+ <dd>
6548
+
6549
+ <dl>
6550
+ <dd>
6551
+
6552
+ ```typescript
6553
+ await client.webhookSubscriptions.delete("webhook_subscription_id_here");
6554
+
6555
+ ```
6556
+ </dd>
6557
+ </dl>
6558
+ </dd>
6559
+ </dl>
6560
+
6561
+ #### ⚙️ Parameters
6562
+
6563
+ <dl>
6564
+ <dd>
6565
+
6566
+ <dl>
6567
+ <dd>
6568
+
6569
+ **id:** `string`
6570
+
6571
+ The ID of the webhook subscription to delete.
6572
+
6573
+ Example: `"whes_Xj8mK2pL9nR4vT7qY5wZ"`
6574
+
6575
+ </dd>
6576
+ </dl>
6577
+
6578
+ <dl>
6579
+ <dd>
6580
+
6581
+ **requestOptions:** `WebhookSubscriptionsClient.RequestOptions`
6582
+
6583
+ </dd>
6584
+ </dl>
6585
+ </dd>
6586
+ </dl>
6587
+
6588
+
5732
6589
  </dd>
5733
6590
  </dl>
5734
6591
  </details>