extend-ai 0.0.18 → 0.1.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 (100) hide show
  1. package/Client.d.ts +27 -27
  2. package/Client.js +37 -41
  3. package/api/errors/index.d.ts +1 -1
  4. package/api/errors/index.js +1 -1
  5. package/api/resources/batchProcessorRun/client/Client.d.ts +3 -3
  6. package/api/resources/batchProcessorRun/client/Client.js +2 -6
  7. package/api/resources/batchWorkflowRun/client/Client.d.ts +3 -3
  8. package/api/resources/batchWorkflowRun/client/Client.js +2 -6
  9. package/api/resources/batchWorkflowRun/types/BatchWorkflowRunCreateRequestInputsItem.d.ts +1 -1
  10. package/api/resources/edit/client/Client.d.ts +3 -3
  11. package/api/resources/edit/client/Client.js +2 -6
  12. package/api/resources/evaluationSet/client/Client.d.ts +3 -3
  13. package/api/resources/evaluationSet/client/Client.js +2 -6
  14. package/api/resources/evaluationSetItem/client/Client.d.ts +3 -3
  15. package/api/resources/evaluationSetItem/client/Client.js +2 -6
  16. package/api/resources/file/client/Client.d.ts +3 -3
  17. package/api/resources/file/client/Client.js +2 -6
  18. package/api/resources/index.d.ts +23 -23
  19. package/api/resources/index.js +24 -24
  20. package/api/resources/parserRun/client/Client.d.ts +3 -3
  21. package/api/resources/parserRun/client/Client.js +2 -6
  22. package/api/resources/processor/client/Client.d.ts +3 -3
  23. package/api/resources/processor/client/Client.js +2 -6
  24. package/api/resources/processorRun/client/Client.d.ts +4 -4
  25. package/api/resources/processorRun/client/Client.js +3 -7
  26. package/api/resources/processorVersion/client/Client.d.ts +23 -23
  27. package/api/resources/processorVersion/client/Client.js +49 -53
  28. package/api/resources/processorVersion/types/index.d.ts +1 -1
  29. package/api/resources/processorVersion/types/index.js +1 -1
  30. package/api/resources/workflow/client/Client.d.ts +3 -3
  31. package/api/resources/workflow/client/Client.js +2 -6
  32. package/api/resources/workflowRun/client/Client.d.ts +3 -3
  33. package/api/resources/workflowRun/client/Client.js +2 -6
  34. package/api/resources/workflowRunOutput/client/Client.d.ts +3 -3
  35. package/api/resources/workflowRunOutput/client/Client.js +2 -6
  36. package/api/types/EditBoundingBox.d.ts +4 -4
  37. package/api/types/ParseConfig.d.ts +1 -1
  38. package/api/types/ParseConfigAdvancedOptions.d.ts +11 -0
  39. package/api/types/ParseConfigAdvancedOptionsExcelParsingMode.d.ts +16 -0
  40. package/api/types/ParseConfigAdvancedOptionsExcelParsingMode.js +10 -0
  41. package/api/types/ParseConfigTarget.d.ts +1 -1
  42. package/api/types/index.d.ts +132 -133
  43. package/api/types/index.js +132 -133
  44. package/dist/Client.d.ts +27 -27
  45. package/dist/Client.js +37 -41
  46. package/dist/api/errors/index.d.ts +1 -1
  47. package/dist/api/errors/index.js +1 -1
  48. package/dist/api/resources/batchProcessorRun/client/Client.d.ts +3 -3
  49. package/dist/api/resources/batchProcessorRun/client/Client.js +2 -6
  50. package/dist/api/resources/batchWorkflowRun/client/Client.d.ts +3 -3
  51. package/dist/api/resources/batchWorkflowRun/client/Client.js +2 -6
  52. package/dist/api/resources/batchWorkflowRun/types/BatchWorkflowRunCreateRequestInputsItem.d.ts +1 -1
  53. package/dist/api/resources/edit/client/Client.d.ts +3 -3
  54. package/dist/api/resources/edit/client/Client.js +2 -6
  55. package/dist/api/resources/evaluationSet/client/Client.d.ts +3 -3
  56. package/dist/api/resources/evaluationSet/client/Client.js +2 -6
  57. package/dist/api/resources/evaluationSetItem/client/Client.d.ts +3 -3
  58. package/dist/api/resources/evaluationSetItem/client/Client.js +2 -6
  59. package/dist/api/resources/file/client/Client.d.ts +3 -3
  60. package/dist/api/resources/file/client/Client.js +2 -6
  61. package/dist/api/resources/index.d.ts +23 -23
  62. package/dist/api/resources/index.js +24 -24
  63. package/dist/api/resources/parserRun/client/Client.d.ts +3 -3
  64. package/dist/api/resources/parserRun/client/Client.js +2 -6
  65. package/dist/api/resources/processor/client/Client.d.ts +3 -3
  66. package/dist/api/resources/processor/client/Client.js +2 -6
  67. package/dist/api/resources/processorRun/client/Client.d.ts +4 -4
  68. package/dist/api/resources/processorRun/client/Client.js +3 -7
  69. package/dist/api/resources/processorVersion/client/Client.d.ts +23 -23
  70. package/dist/api/resources/processorVersion/client/Client.js +49 -53
  71. package/dist/api/resources/processorVersion/types/index.d.ts +1 -1
  72. package/dist/api/resources/processorVersion/types/index.js +1 -1
  73. package/dist/api/resources/workflow/client/Client.d.ts +3 -3
  74. package/dist/api/resources/workflow/client/Client.js +2 -6
  75. package/dist/api/resources/workflowRun/client/Client.d.ts +3 -3
  76. package/dist/api/resources/workflowRun/client/Client.js +2 -6
  77. package/dist/api/resources/workflowRunOutput/client/Client.d.ts +3 -3
  78. package/dist/api/resources/workflowRunOutput/client/Client.js +2 -6
  79. package/dist/api/types/EditBoundingBox.d.ts +4 -4
  80. package/dist/api/types/ParseConfig.d.ts +1 -1
  81. package/dist/api/types/ParseConfigAdvancedOptions.d.ts +11 -0
  82. package/dist/api/types/ParseConfigAdvancedOptionsExcelParsingMode.d.ts +16 -0
  83. package/dist/api/types/ParseConfigAdvancedOptionsExcelParsingMode.js +10 -0
  84. package/dist/api/types/ParseConfigTarget.d.ts +1 -1
  85. package/dist/api/types/index.d.ts +132 -133
  86. package/dist/api/types/index.js +132 -133
  87. package/dist/version.d.ts +1 -1
  88. package/dist/version.js +1 -1
  89. package/package.json +1 -1
  90. package/reference.md +511 -511
  91. package/version.d.ts +1 -1
  92. package/version.js +1 -1
  93. package/api/types/OutputMetadata.d.ts +0 -5
  94. package/api/types/OutputMetadata.js +0 -5
  95. package/api/types/OutputMetadataValue.d.ts +0 -22
  96. package/api/types/OutputMetadataValue.js +0 -5
  97. package/dist/api/types/OutputMetadata.d.ts +0 -5
  98. package/dist/api/types/OutputMetadata.js +0 -5
  99. package/dist/api/types/OutputMetadataValue.d.ts +0 -22
  100. package/dist/api/types/OutputMetadataValue.js +0 -5
package/reference.md CHANGED
@@ -78,9 +78,9 @@ await client.parseAsync({
78
78
 
79
79
  ##
80
80
 
81
- ## WorkflowRun
81
+ ## File
82
82
 
83
- <details><summary><code>client.workflowRun.<a href="/src/api/resources/workflowRun/client/Client.ts">list</a>({ ...params }) -> Extend.WorkflowRunListResponse</code></summary>
83
+ <details><summary><code>client.file.<a href="/src/api/resources/file/client/Client.ts">list</a>({ ...params }) -> Extend.FileListResponse</code></summary>
84
84
  <dl>
85
85
  <dd>
86
86
 
@@ -92,7 +92,7 @@ await client.parseAsync({
92
92
  <dl>
93
93
  <dd>
94
94
 
95
- List runs of a Workflow. Workflows are sequences of steps that process files and data in a specific order to achieve a desired outcome. A WorkflowRun represents a single execution of a workflow against a file.
95
+ List files in your account. Files represent documents that have been uploaded to Extend. This endpoint returns a paginated response. You can use the `nextPageToken` to fetch subsequent results.
96
96
 
97
97
  </dd>
98
98
  </dl>
@@ -108,12 +108,8 @@ List runs of a Workflow. Workflows are sequences of steps that process files and
108
108
  <dd>
109
109
 
110
110
  ```typescript
111
- await client.workflowRun.list({
112
- status: "PENDING",
113
- workflowId: "workflowId",
114
- batchId: "batchId",
115
- fileNameContains: "fileNameContains",
116
- sortBy: "updatedAt",
111
+ await client.file.list({
112
+ nameContains: "nameContains",
117
113
  sortDir: "asc",
118
114
  nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ=",
119
115
  maxPageSize: 1,
@@ -133,7 +129,7 @@ await client.workflowRun.list({
133
129
  <dl>
134
130
  <dd>
135
131
 
136
- **request:** `Extend.WorkflowRunListRequest`
132
+ **request:** `Extend.FileListRequest`
137
133
 
138
134
  </dd>
139
135
  </dl>
@@ -141,7 +137,7 @@ await client.workflowRun.list({
141
137
  <dl>
142
138
  <dd>
143
139
 
144
- **requestOptions:** `WorkflowRun.RequestOptions`
140
+ **requestOptions:** `File_.RequestOptions`
145
141
 
146
142
  </dd>
147
143
  </dl>
@@ -152,7 +148,7 @@ await client.workflowRun.list({
152
148
  </dl>
153
149
  </details>
154
150
 
155
- <details><summary><code>client.workflowRun.<a href="/src/api/resources/workflowRun/client/Client.ts">create</a>({ ...params }) -> Extend.WorkflowRunCreateResponse</code></summary>
151
+ <details><summary><code>client.file.<a href="/src/api/resources/file/client/Client.ts">get</a>(id, { ...params }) -> Extend.FileGetResponse</code></summary>
156
152
  <dl>
157
153
  <dd>
158
154
 
@@ -164,7 +160,7 @@ await client.workflowRun.list({
164
160
  <dl>
165
161
  <dd>
166
162
 
167
- Run a Workflow with files. A Workflow is a sequence of steps that process files and data in a specific order to achieve a desired outcome. A WorkflowRun will be created for each file processed. A WorkflowRun represents a single execution of a workflow against a file.
163
+ Fetch a file by its ID to obtain additional details and the raw file content.
168
164
 
169
165
  </dd>
170
166
  </dl>
@@ -180,8 +176,10 @@ Run a Workflow with files. A Workflow is a sequence of steps that process files
180
176
  <dd>
181
177
 
182
178
  ```typescript
183
- await client.workflowRun.create({
184
- workflowId: "workflow_id_here",
179
+ await client.file.get("file_id_here", {
180
+ rawText: true,
181
+ markdown: true,
182
+ html: true,
185
183
  });
186
184
  ```
187
185
 
@@ -198,7 +196,11 @@ await client.workflowRun.create({
198
196
  <dl>
199
197
  <dd>
200
198
 
201
- **request:** `Extend.WorkflowRunCreateRequest`
199
+ **id:** `string`
200
+
201
+ Extend's ID for the file. It will always start with `"file_"`. This ID is returned when creating a new File, or the value on the `fileId` field in a WorkflowRun.
202
+
203
+ Example: `"file_Xj8mK2pL9nR4vT7qY5wZ"`
202
204
 
203
205
  </dd>
204
206
  </dl>
@@ -206,7 +208,15 @@ await client.workflowRun.create({
206
208
  <dl>
207
209
  <dd>
208
210
 
209
- **requestOptions:** `WorkflowRun.RequestOptions`
211
+ **request:** `Extend.FileGetRequest`
212
+
213
+ </dd>
214
+ </dl>
215
+
216
+ <dl>
217
+ <dd>
218
+
219
+ **requestOptions:** `File_.RequestOptions`
210
220
 
211
221
  </dd>
212
222
  </dl>
@@ -217,7 +227,7 @@ await client.workflowRun.create({
217
227
  </dl>
218
228
  </details>
219
229
 
220
- <details><summary><code>client.workflowRun.<a href="/src/api/resources/workflowRun/client/Client.ts">get</a>(workflowRunId) -> Extend.WorkflowRunGetResponse</code></summary>
230
+ <details><summary><code>client.file.<a href="/src/api/resources/file/client/Client.ts">delete</a>(id) -> Extend.FileDeleteResponse</code></summary>
221
231
  <dl>
222
232
  <dd>
223
233
 
@@ -229,7 +239,9 @@ await client.workflowRun.create({
229
239
  <dl>
230
240
  <dd>
231
241
 
232
- Once a workflow has been run, you can check the status and output of a specific WorkflowRun.
242
+ Delete a file and all associated data from Extend. This operation is permanent and cannot be undone.
243
+
244
+ This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.
233
245
 
234
246
  </dd>
235
247
  </dl>
@@ -245,7 +257,7 @@ Once a workflow has been run, you can check the status and output of a specific
245
257
  <dd>
246
258
 
247
259
  ```typescript
248
- await client.workflowRun.get("workflow_run_id_here");
260
+ await client.file.delete("file_id_here");
249
261
  ```
250
262
 
251
263
  </dd>
@@ -261,11 +273,11 @@ await client.workflowRun.get("workflow_run_id_here");
261
273
  <dl>
262
274
  <dd>
263
275
 
264
- **workflowRunId:** `string`
276
+ **id:** `string`
265
277
 
266
- The ID of the WorkflowRun that was outputted after a Workflow was run through the API.
278
+ The ID of the file to delete.
267
279
 
268
- Example: `"workflow_run_8k9m-xyzAB_Pqrst-Nvw4"`
280
+ Example: `"file_xK9mLPqRtN3vS8wF5hB2cQ"`
269
281
 
270
282
  </dd>
271
283
  </dl>
@@ -273,7 +285,7 @@ Example: `"workflow_run_8k9m-xyzAB_Pqrst-Nvw4"`
273
285
  <dl>
274
286
  <dd>
275
287
 
276
- **requestOptions:** `WorkflowRun.RequestOptions`
288
+ **requestOptions:** `File_.RequestOptions`
277
289
 
278
290
  </dd>
279
291
  </dl>
@@ -284,7 +296,7 @@ Example: `"workflow_run_8k9m-xyzAB_Pqrst-Nvw4"`
284
296
  </dl>
285
297
  </details>
286
298
 
287
- <details><summary><code>client.workflowRun.<a href="/src/api/resources/workflowRun/client/Client.ts">update</a>(workflowRunId, { ...params }) -> Extend.WorkflowRunUpdateResponse</code></summary>
299
+ <details><summary><code>client.file.<a href="/src/api/resources/file/client/Client.ts">upload</a>(file) -> Extend.FileUploadResponse</code></summary>
288
300
  <dl>
289
301
  <dd>
290
302
 
@@ -296,7 +308,15 @@ Example: `"workflow_run_8k9m-xyzAB_Pqrst-Nvw4"`
296
308
  <dl>
297
309
  <dd>
298
310
 
299
- You can update the name and metadata of an in progress WorkflowRun at any time using this endpoint.
311
+ Upload and create a new file in Extend.
312
+
313
+ This endpoint accepts file contents and registers them as a File in Extend, which can be used for [running workflows](https://docs.extend.ai/2025-04-21/developers/api-reference/workflow-endpoints/run-workflow), [creating evaluation set items](https://docs.extend.ai/2025-04-21/developers/api-reference/evaluation-set-endpoints/bulk-create-evaluation-set-items), [parsing](https://docs.extend.ai/2025-04-21/developers/api-reference/parse-endpoints/parse-file), etc.
314
+
315
+ If an uploaded file is detected as a Word or PowerPoint document, it will be automatically converted to a PDF.
316
+
317
+ Supported file types can be found [here](/product/general/supported-file-types).
318
+
319
+ This endpoint requires multipart form encoding. Most HTTP clients will handle this encoding automatically (see the examples).
300
320
 
301
321
  </dd>
302
322
  </dl>
@@ -312,7 +332,7 @@ You can update the name and metadata of an in progress WorkflowRun at any time u
312
332
  <dd>
313
333
 
314
334
  ```typescript
315
- await client.workflowRun.update("workflow_run_id_here");
335
+ await client.file.upload(createReadStream("path/to/file"));
316
336
  ```
317
337
 
318
338
  </dd>
@@ -328,19 +348,7 @@ await client.workflowRun.update("workflow_run_id_here");
328
348
  <dl>
329
349
  <dd>
330
350
 
331
- **workflowRunId:** `string`
332
-
333
- The ID of the WorkflowRun. This ID will start with "workflow_run". This ID can be found in the API response when creating a Workflow Run, or in the "history" tab of a workflow on the Extend platform.
334
-
335
- Example: `"workflow_run_8k9m-xyzAB_Pqrst-Nvw4"`
336
-
337
- </dd>
338
- </dl>
339
-
340
- <dl>
341
- <dd>
342
-
343
- **request:** `Extend.WorkflowRunUpdateRequest`
351
+ **file:** `File | fs.ReadStream | Blob`
344
352
 
345
353
  </dd>
346
354
  </dl>
@@ -348,7 +356,7 @@ Example: `"workflow_run_8k9m-xyzAB_Pqrst-Nvw4"`
348
356
  <dl>
349
357
  <dd>
350
358
 
351
- **requestOptions:** `WorkflowRun.RequestOptions`
359
+ **requestOptions:** `File_.RequestOptions`
352
360
 
353
361
  </dd>
354
362
  </dl>
@@ -359,7 +367,9 @@ Example: `"workflow_run_8k9m-xyzAB_Pqrst-Nvw4"`
359
367
  </dl>
360
368
  </details>
361
369
 
362
- <details><summary><code>client.workflowRun.<a href="/src/api/resources/workflowRun/client/Client.ts">delete</a>(workflowRunId) -> Extend.WorkflowRunDeleteResponse</code></summary>
370
+ ## ParserRun
371
+
372
+ <details><summary><code>client.parserRun.<a href="/src/api/resources/parserRun/client/Client.ts">get</a>(id, { ...params }) -> Extend.ParserRunGetResponse</code></summary>
363
373
  <dl>
364
374
  <dd>
365
375
 
@@ -371,9 +381,11 @@ Example: `"workflow_run_8k9m-xyzAB_Pqrst-Nvw4"`
371
381
  <dl>
372
382
  <dd>
373
383
 
374
- Delete a workflow run and all associated data from Extend. This operation is permanent and cannot be undone.
384
+ Retrieve the status and results of a parser run.
375
385
 
376
- This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.
386
+ Use this endpoint to get results for a parser run that has already completed, or to check on the status of an asynchronous parser run initiated via the [Parse File Asynchronously](https://docs.extend.ai/2025-04-21/developers/api-reference/parse-endpoints/parse-file-async) endpoint.
387
+
388
+ If parsing is still in progress, you'll receive a response with just the status. Once complete, you'll receive the full parsed content in the response.
377
389
 
378
390
  </dd>
379
391
  </dl>
@@ -389,7 +401,9 @@ This endpoint can be used if you'd like to manage data retention on your own rat
389
401
  <dd>
390
402
 
391
403
  ```typescript
392
- await client.workflowRun.delete("workflow_run_id_here");
404
+ await client.parserRun.get("parser_run_id_here", {
405
+ responseType: "json",
406
+ });
393
407
  ```
394
408
 
395
409
  </dd>
@@ -405,11 +419,11 @@ await client.workflowRun.delete("workflow_run_id_here");
405
419
  <dl>
406
420
  <dd>
407
421
 
408
- **workflowRunId:** `string`
422
+ **id:** `string`
409
423
 
410
- The ID of the workflow run to delete.
424
+ The unique identifier for the parser run.
411
425
 
412
- Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
426
+ Example: `"parser_run_xK9mLPqRtN3vS8wF5hB2cQ"`
413
427
 
414
428
  </dd>
415
429
  </dl>
@@ -417,7 +431,15 @@ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
417
431
  <dl>
418
432
  <dd>
419
433
 
420
- **requestOptions:** `WorkflowRun.RequestOptions`
434
+ **request:** `Extend.ParserRunGetRequest`
435
+
436
+ </dd>
437
+ </dl>
438
+
439
+ <dl>
440
+ <dd>
441
+
442
+ **requestOptions:** `ParserRun.RequestOptions`
421
443
 
422
444
  </dd>
423
445
  </dl>
@@ -428,7 +450,7 @@ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
428
450
  </dl>
429
451
  </details>
430
452
 
431
- <details><summary><code>client.workflowRun.<a href="/src/api/resources/workflowRun/client/Client.ts">cancel</a>(workflowRunId) -> Extend.WorkflowRunCancelResponse</code></summary>
453
+ <details><summary><code>client.parserRun.<a href="/src/api/resources/parserRun/client/Client.ts">delete</a>(id) -> Extend.ParserRunDeleteResponse</code></summary>
432
454
  <dl>
433
455
  <dd>
434
456
 
@@ -440,9 +462,9 @@ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
440
462
  <dl>
441
463
  <dd>
442
464
 
443
- Cancel a running workflow run by its ID. This endpoint allows you to stop a workflow run that is currently in progress.
465
+ Delete a parser run and all associated data from Extend. This operation is permanent and cannot be undone.
444
466
 
445
- Note: Only workflow runs with a status of `PROCESSING` or `PENDING` can be cancelled. Workflow runs that are completed, failed, in review, rejected, or already cancelled cannot be cancelled.
467
+ This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.
446
468
 
447
469
  </dd>
448
470
  </dl>
@@ -458,7 +480,7 @@ Note: Only workflow runs with a status of `PROCESSING` or `PENDING` can be cance
458
480
  <dd>
459
481
 
460
482
  ```typescript
461
- await client.workflowRun.cancel("workflow_run_id_here");
483
+ await client.parserRun.delete("parser_run_id_here");
462
484
  ```
463
485
 
464
486
  </dd>
@@ -474,11 +496,11 @@ await client.workflowRun.cancel("workflow_run_id_here");
474
496
  <dl>
475
497
  <dd>
476
498
 
477
- **workflowRunId:** `string`
499
+ **id:** `string`
478
500
 
479
- The ID of the workflow run to cancel.
501
+ The ID of the parser run to delete.
480
502
 
481
- Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
503
+ Example: `"parser_run_xK9mLPqRtN3vS8wF5hB2cQ"`
482
504
 
483
505
  </dd>
484
506
  </dl>
@@ -486,7 +508,7 @@ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
486
508
  <dl>
487
509
  <dd>
488
510
 
489
- **requestOptions:** `WorkflowRun.RequestOptions`
511
+ **requestOptions:** `ParserRun.RequestOptions`
490
512
 
491
513
  </dd>
492
514
  </dl>
@@ -497,9 +519,9 @@ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
497
519
  </dl>
498
520
  </details>
499
521
 
500
- ## BatchWorkflowRun
522
+ ## Edit
501
523
 
502
- <details><summary><code>client.batchWorkflowRun.<a href="/src/api/resources/batchWorkflowRun/client/Client.ts">create</a>({ ...params }) -> Extend.BatchWorkflowRunCreateResponse</code></summary>
524
+ <details><summary><code>client.edit.<a href="/src/api/resources/edit/client/Client.ts">create</a>({ ...params }) -> Extend.EditRun</code></summary>
503
525
  <dl>
504
526
  <dd>
505
527
 
@@ -511,23 +533,13 @@ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
511
533
  <dl>
512
534
  <dd>
513
535
 
514
- 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.
515
-
516
- Unlike the single [Run Workflow](/developers/api-reference/workflow-endpoints/run-workflow) endpoint which returns the details of the created workflow runs immediately, this batch endpoint returns a `batchId`.
517
-
518
- Our recommended usage pattern is to integrate with [Webhooks](/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/2025-04-21/developers/api-reference/workflow-endpoints/list-workflow-runs) endpoint to fetch all runs via a batch, and then [Get Workflow Run](https://docs.extend.ai/2025-04-21/developers/api-reference/workflow-endpoints/get-workflow-run) to fetch the full outputs each run.
519
-
520
- **Priority:** All workflow runs created through this batch endpoint are automatically assigned a priority of 90.
521
-
522
- **Processing and Monitoring:**
523
- Upon successful submission, the endpoint returns a `batchId`. The individual workflow runs are then queued for processing.
536
+ Edit and manipulate PDF documents by detecting and filling form fields.
537
+ This is a synchronous endpoint that will wait for the edit operation to complete (up to 5 minutes) before returning results. For longer operations, use the [Edit File Async](/developers/api-reference/edit-endpoints/edit-file-async) endpoint.
524
538
 
525
- - **Monitoring:** Track the progress and consume results of individual runs using [Webhooks](/product/webhooks/configuration). Subscribe to events like `workflow_run.completed`, `workflow_run.failed`, etc. The webhook payload for these events will include the corresponding `batchId` and the `metadata` you provided for each input.
526
- - **Fetching Results:** You can also use the [List Workflow Runs](https://docs.extend.ai/2025-04-21/developers/api-reference/workflow-endpoints/list-workflow-runs) endpoint and filter using the `batchId` query param.
527
- </dd>
528
- </dl>
529
- </dd>
530
- </dl>
539
+ </dd>
540
+ </dl>
541
+ </dd>
542
+ </dl>
531
543
 
532
544
  #### 🔌 Usage
533
545
 
@@ -538,9 +550,8 @@ Upon successful submission, the endpoint returns a `batchId`. The individual wor
538
550
  <dd>
539
551
 
540
552
  ```typescript
541
- await client.batchWorkflowRun.create({
542
- workflowId: "workflow_id_here",
543
- inputs: [{}],
553
+ await client.edit.create({
554
+ file: {},
544
555
  });
545
556
  ```
546
557
 
@@ -557,7 +568,7 @@ await client.batchWorkflowRun.create({
557
568
  <dl>
558
569
  <dd>
559
570
 
560
- **request:** `Extend.BatchWorkflowRunCreateRequest`
571
+ **request:** `Extend.EditCreateRequest`
561
572
 
562
573
  </dd>
563
574
  </dl>
@@ -565,7 +576,7 @@ await client.batchWorkflowRun.create({
565
576
  <dl>
566
577
  <dd>
567
578
 
568
- **requestOptions:** `BatchWorkflowRun.RequestOptions`
579
+ **requestOptions:** `Edit.RequestOptions`
569
580
 
570
581
  </dd>
571
582
  </dl>
@@ -576,9 +587,7 @@ await client.batchWorkflowRun.create({
576
587
  </dl>
577
588
  </details>
578
589
 
579
- ## ProcessorRun
580
-
581
- <details><summary><code>client.processorRun.<a href="/src/api/resources/processorRun/client/Client.ts">list</a>({ ...params }) -> Extend.ProcessorRunListResponse</code></summary>
590
+ <details><summary><code>client.edit.<a href="/src/api/resources/edit/client/Client.ts">createAsync</a>({ ...params }) -> Extend.EditRunStatus</code></summary>
582
591
  <dl>
583
592
  <dd>
584
593
 
@@ -590,12 +599,19 @@ await client.batchWorkflowRun.create({
590
599
  <dl>
591
600
  <dd>
592
601
 
593
- List runs of a Processor. A ProcessorRun represents a single execution of a processor against a file.
602
+ Edit and manipulate PDF documents **asynchronously** by filling forms, adding/modifying text fields, and applying structured changes.
594
603
 
595
- </dd>
596
- </dl>
597
- </dd>
598
- </dl>
604
+ The Edit Async endpoint allows you to convert and edit documents asynchronously and get an edit run ID that can be used to check status and retrieve results with the [Get Edit Run](/developers/api-reference/edit-endpoints/get-edit-run) endpoint.
605
+
606
+ This is useful for:
607
+
608
+ - Large files that may take longer to process
609
+ - Avoiding timeout issues with synchronous editing
610
+ - Processing multiple files in parallel
611
+ </dd>
612
+ </dl>
613
+ </dd>
614
+ </dl>
599
615
 
600
616
  #### 🔌 Usage
601
617
 
@@ -606,17 +622,8 @@ List runs of a Processor. A ProcessorRun represents a single execution of a proc
606
622
  <dd>
607
623
 
608
624
  ```typescript
609
- await client.processorRun.list({
610
- status: "PENDING",
611
- processorId: "processorId",
612
- processorType: "EXTRACT",
613
- sourceId: "sourceId",
614
- source: "ADMIN",
615
- fileNameContains: "fileNameContains",
616
- sortBy: "updatedAt",
617
- sortDir: "asc",
618
- nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ=",
619
- maxPageSize: 1,
625
+ await client.edit.createAsync({
626
+ file: {},
620
627
  });
621
628
  ```
622
629
 
@@ -633,7 +640,7 @@ await client.processorRun.list({
633
640
  <dl>
634
641
  <dd>
635
642
 
636
- **request:** `Extend.ProcessorRunListRequest`
643
+ **request:** `Extend.EditCreateAsyncRequest`
637
644
 
638
645
  </dd>
639
646
  </dl>
@@ -641,7 +648,7 @@ await client.processorRun.list({
641
648
  <dl>
642
649
  <dd>
643
650
 
644
- **requestOptions:** `ProcessorRun.RequestOptions`
651
+ **requestOptions:** `Edit.RequestOptions`
645
652
 
646
653
  </dd>
647
654
  </dl>
@@ -652,7 +659,7 @@ await client.processorRun.list({
652
659
  </dl>
653
660
  </details>
654
661
 
655
- <details><summary><code>client.processorRun.<a href="/src/api/resources/processorRun/client/Client.ts">create</a>({ ...params }) -> Extend.ProcessorRunCreateResponse</code></summary>
662
+ <details><summary><code>client.edit.<a href="/src/api/resources/edit/client/Client.ts">get</a>(id) -> Extend.EditGetResponse</code></summary>
656
663
  <dl>
657
664
  <dd>
658
665
 
@@ -664,21 +671,16 @@ await client.processorRun.list({
664
671
  <dl>
665
672
  <dd>
666
673
 
667
- Run processors (extraction, classification, splitting, etc.) on a given document.
668
-
669
- **Synchronous vs Asynchronous Processing:**
674
+ Retrieve the status and results of an edit run.
670
675
 
671
- - **Asynchronous (default)**: Returns immediately with `PROCESSING` status. Use webhooks or polling to get results.
672
- - **Synchronous**: Set `sync: true` to wait for completion and get final results in the response (5-minute timeout).
676
+ Use this endpoint to get results for an edit run that has already completed, or to check on the status of an asynchronous edit run initiated via the [Edit File Asynchronously](/developers/api-reference/edit-endpoints/edit-file-async) endpoint.
673
677
 
674
- **For asynchronous processing:**
678
+ If editing is still in progress, you'll receive a response with just the status. Once complete, you'll receive the full edited file information in the response.
675
679
 
676
- - You can [configure webhooks](https://docs.extend.ai/2025-04-21/developers/webhooks/configuration) to receive notifications when a processor run is complete or failed.
677
- - 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.
678
- </dd>
679
- </dl>
680
- </dd>
681
- </dl>
680
+ </dd>
681
+ </dl>
682
+ </dd>
683
+ </dl>
682
684
 
683
685
  #### 🔌 Usage
684
686
 
@@ -689,9 +691,7 @@ Run processors (extraction, classification, splitting, etc.) on a given document
689
691
  <dd>
690
692
 
691
693
  ```typescript
692
- await client.processorRun.create({
693
- processorId: "processor_id_here",
694
- });
694
+ await client.edit.get("edit_run_id_here");
695
695
  ```
696
696
 
697
697
  </dd>
@@ -707,7 +707,11 @@ await client.processorRun.create({
707
707
  <dl>
708
708
  <dd>
709
709
 
710
- **request:** `Extend.ProcessorRunCreateRequest`
710
+ **id:** `string`
711
+
712
+ The unique identifier for the edit run.
713
+
714
+ Example: `"edit_run_xK9mLPqRtN3vS8wF5hB2cQ"`
711
715
 
712
716
  </dd>
713
717
  </dl>
@@ -715,7 +719,7 @@ await client.processorRun.create({
715
719
  <dl>
716
720
  <dd>
717
721
 
718
- **requestOptions:** `ProcessorRun.RequestOptions`
722
+ **requestOptions:** `Edit.RequestOptions`
719
723
 
720
724
  </dd>
721
725
  </dl>
@@ -726,7 +730,7 @@ await client.processorRun.create({
726
730
  </dl>
727
731
  </details>
728
732
 
729
- <details><summary><code>client.processorRun.<a href="/src/api/resources/processorRun/client/Client.ts">get</a>(id) -> Extend.ProcessorRunGetResponse</code></summary>
733
+ <details><summary><code>client.edit.<a href="/src/api/resources/edit/client/Client.ts">delete</a>(id) -> Extend.EditDeleteResponse</code></summary>
730
734
  <dl>
731
735
  <dd>
732
736
 
@@ -738,9 +742,9 @@ await client.processorRun.create({
738
742
  <dl>
739
743
  <dd>
740
744
 
741
- Retrieve details about a specific processor run, including its status, outputs, and any edits made during review.
745
+ Delete an edit run and all associated data from Extend. This operation is permanent and cannot be undone.
742
746
 
743
- 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.
747
+ This endpoint can be used if you'd like to manage data retention on your own rather than relying on automated data retention policies, or to make one-off deletions for your downstream customers.
744
748
 
745
749
  </dd>
746
750
  </dl>
@@ -756,7 +760,7 @@ A common use case for this endpoint is to poll for the status and final output o
756
760
  <dd>
757
761
 
758
762
  ```typescript
759
- await client.processorRun.get("processor_run_id_here");
763
+ await client.edit.delete("edit_run_id_here");
760
764
  ```
761
765
 
762
766
  </dd>
@@ -774,9 +778,9 @@ await client.processorRun.get("processor_run_id_here");
774
778
 
775
779
  **id:** `string`
776
780
 
777
- The unique identifier for this processor run.
781
+ The ID of the edit run to delete.
778
782
 
779
- Example: `"dpr_Xj8mK2pL9nR4vT7qY5wZ"`
783
+ Example: `"edit_run_xK9mLPqRtN3vS8wF5hB2cQ"`
780
784
 
781
785
  </dd>
782
786
  </dl>
@@ -784,7 +788,7 @@ Example: `"dpr_Xj8mK2pL9nR4vT7qY5wZ"`
784
788
  <dl>
785
789
  <dd>
786
790
 
787
- **requestOptions:** `ProcessorRun.RequestOptions`
791
+ **requestOptions:** `Edit.RequestOptions`
788
792
 
789
793
  </dd>
790
794
  </dl>
@@ -795,7 +799,9 @@ Example: `"dpr_Xj8mK2pL9nR4vT7qY5wZ"`
795
799
  </dl>
796
800
  </details>
797
801
 
798
- <details><summary><code>client.processorRun.<a href="/src/api/resources/processorRun/client/Client.ts">delete</a>(id) -> Extend.ProcessorRunDeleteResponse</code></summary>
802
+ ## Workflow
803
+
804
+ <details><summary><code>client.workflow.<a href="/src/api/resources/workflow/client/Client.ts">create</a>({ ...params }) -> Extend.WorkflowCreateResponse</code></summary>
799
805
  <dl>
800
806
  <dd>
801
807
 
@@ -807,9 +813,9 @@ Example: `"dpr_Xj8mK2pL9nR4vT7qY5wZ"`
807
813
  <dl>
808
814
  <dd>
809
815
 
810
- Delete a processor run and all associated data from Extend. This operation is permanent and cannot be undone.
816
+ Create a new workflow in Extend. Workflows are sequences of steps that process files and data in a specific order to achieve a desired outcome.
811
817
 
812
- This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.
818
+ This endpoint will create a new workflow in Extend, which can then be configured and deployed. Typically, workflows are created from our UI, however this endpoint can be used to create workflows programmatically. Configuration of the flow still needs to be done in the dashboard.
813
819
 
814
820
  </dd>
815
821
  </dl>
@@ -825,7 +831,9 @@ This endpoint can be used if you'd like to manage data retention on your own rat
825
831
  <dd>
826
832
 
827
833
  ```typescript
828
- await client.processorRun.delete("processor_run_id_here");
834
+ await client.workflow.create({
835
+ name: "Invoice Processing",
836
+ });
829
837
  ```
830
838
 
831
839
  </dd>
@@ -841,11 +849,7 @@ await client.processorRun.delete("processor_run_id_here");
841
849
  <dl>
842
850
  <dd>
843
851
 
844
- **id:** `string`
845
-
846
- The ID of the processor run to delete.
847
-
848
- Example: `"dpr_Xj8mK2pL9nR4vT7qY5wZ"`
852
+ **request:** `Extend.WorkflowCreateRequest`
849
853
 
850
854
  </dd>
851
855
  </dl>
@@ -853,7 +857,7 @@ Example: `"dpr_Xj8mK2pL9nR4vT7qY5wZ"`
853
857
  <dl>
854
858
  <dd>
855
859
 
856
- **requestOptions:** `ProcessorRun.RequestOptions`
860
+ **requestOptions:** `Workflow.RequestOptions`
857
861
 
858
862
  </dd>
859
863
  </dl>
@@ -864,7 +868,9 @@ Example: `"dpr_Xj8mK2pL9nR4vT7qY5wZ"`
864
868
  </dl>
865
869
  </details>
866
870
 
867
- <details><summary><code>client.processorRun.<a href="/src/api/resources/processorRun/client/Client.ts">cancel</a>(id) -> Extend.ProcessorRunCancelResponse</code></summary>
871
+ ## WorkflowRun
872
+
873
+ <details><summary><code>client.workflowRun.<a href="/src/api/resources/workflowRun/client/Client.ts">list</a>({ ...params }) -> Extend.WorkflowRunListResponse</code></summary>
868
874
  <dl>
869
875
  <dd>
870
876
 
@@ -876,9 +882,7 @@ Example: `"dpr_Xj8mK2pL9nR4vT7qY5wZ"`
876
882
  <dl>
877
883
  <dd>
878
884
 
879
- Cancel a running processor run by its ID. This endpoint allows you to stop a processor run that is currently in progress.
880
-
881
- Note: Only processor runs with a status of `"PROCESSING"` can be cancelled. Processor runs that have already completed, failed, or been cancelled cannot be cancelled again.
885
+ List runs of a Workflow. Workflows are sequences of steps that process files and data in a specific order to achieve a desired outcome. A WorkflowRun represents a single execution of a workflow against a file.
882
886
 
883
887
  </dd>
884
888
  </dl>
@@ -894,7 +898,16 @@ Note: Only processor runs with a status of `"PROCESSING"` can be cancelled. Proc
894
898
  <dd>
895
899
 
896
900
  ```typescript
897
- await client.processorRun.cancel("processor_run_id_here");
901
+ await client.workflowRun.list({
902
+ status: "PENDING",
903
+ workflowId: "workflowId",
904
+ batchId: "batchId",
905
+ fileNameContains: "fileNameContains",
906
+ sortBy: "updatedAt",
907
+ sortDir: "asc",
908
+ nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ=",
909
+ maxPageSize: 1,
910
+ });
898
911
  ```
899
912
 
900
913
  </dd>
@@ -910,11 +923,7 @@ await client.processorRun.cancel("processor_run_id_here");
910
923
  <dl>
911
924
  <dd>
912
925
 
913
- **id:** `string`
914
-
915
- The unique identifier for the processor run to cancel.
916
-
917
- Example: `"dpr_Xj8mK2pL9nR4vT7qY5wZ"`
926
+ **request:** `Extend.WorkflowRunListRequest`
918
927
 
919
928
  </dd>
920
929
  </dl>
@@ -922,7 +931,7 @@ Example: `"dpr_Xj8mK2pL9nR4vT7qY5wZ"`
922
931
  <dl>
923
932
  <dd>
924
933
 
925
- **requestOptions:** `ProcessorRun.RequestOptions`
934
+ **requestOptions:** `WorkflowRun.RequestOptions`
926
935
 
927
936
  </dd>
928
937
  </dl>
@@ -933,9 +942,7 @@ Example: `"dpr_Xj8mK2pL9nR4vT7qY5wZ"`
933
942
  </dl>
934
943
  </details>
935
944
 
936
- ## Processor
937
-
938
- <details><summary><code>client.processor.<a href="/src/api/resources/processor/client/Client.ts">list</a>({ ...params }) -> Extend.ListProcessorsResponse</code></summary>
945
+ <details><summary><code>client.workflowRun.<a href="/src/api/resources/workflowRun/client/Client.ts">create</a>({ ...params }) -> Extend.WorkflowRunCreateResponse</code></summary>
939
946
  <dl>
940
947
  <dd>
941
948
 
@@ -947,7 +954,7 @@ Example: `"dpr_Xj8mK2pL9nR4vT7qY5wZ"`
947
954
  <dl>
948
955
  <dd>
949
956
 
950
- List all processors in your organization
957
+ Run a Workflow with files. A Workflow is a sequence of steps that process files and data in a specific order to achieve a desired outcome. A WorkflowRun will be created for each file processed. A WorkflowRun represents a single execution of a workflow against a file.
951
958
 
952
959
  </dd>
953
960
  </dl>
@@ -963,12 +970,8 @@ List all processors in your organization
963
970
  <dd>
964
971
 
965
972
  ```typescript
966
- await client.processor.list({
967
- type: "EXTRACT",
968
- nextPageToken: "nextPageToken",
969
- maxPageSize: 1,
970
- sortBy: "createdAt",
971
- sortDir: "asc",
973
+ await client.workflowRun.create({
974
+ workflowId: "workflow_id_here",
972
975
  });
973
976
  ```
974
977
 
@@ -985,7 +988,7 @@ await client.processor.list({
985
988
  <dl>
986
989
  <dd>
987
990
 
988
- **request:** `Extend.ProcessorListRequest`
991
+ **request:** `Extend.WorkflowRunCreateRequest`
989
992
 
990
993
  </dd>
991
994
  </dl>
@@ -993,7 +996,7 @@ await client.processor.list({
993
996
  <dl>
994
997
  <dd>
995
998
 
996
- **requestOptions:** `Processor.RequestOptions`
999
+ **requestOptions:** `WorkflowRun.RequestOptions`
997
1000
 
998
1001
  </dd>
999
1002
  </dl>
@@ -1004,7 +1007,7 @@ await client.processor.list({
1004
1007
  </dl>
1005
1008
  </details>
1006
1009
 
1007
- <details><summary><code>client.processor.<a href="/src/api/resources/processor/client/Client.ts">create</a>({ ...params }) -> Extend.ProcessorCreateResponse</code></summary>
1010
+ <details><summary><code>client.workflowRun.<a href="/src/api/resources/workflowRun/client/Client.ts">get</a>(workflowRunId) -> Extend.WorkflowRunGetResponse</code></summary>
1008
1011
  <dl>
1009
1012
  <dd>
1010
1013
 
@@ -1016,7 +1019,7 @@ await client.processor.list({
1016
1019
  <dl>
1017
1020
  <dd>
1018
1021
 
1019
- Create a new processor in Extend, optionally cloning from an existing processor
1022
+ Once a workflow has been run, you can check the status and output of a specific WorkflowRun.
1020
1023
 
1021
1024
  </dd>
1022
1025
  </dl>
@@ -1032,10 +1035,7 @@ Create a new processor in Extend, optionally cloning from an existing processor
1032
1035
  <dd>
1033
1036
 
1034
1037
  ```typescript
1035
- await client.processor.create({
1036
- name: "My Processor Name",
1037
- type: "EXTRACT",
1038
- });
1038
+ await client.workflowRun.get("workflow_run_id_here");
1039
1039
  ```
1040
1040
 
1041
1041
  </dd>
@@ -1051,7 +1051,11 @@ await client.processor.create({
1051
1051
  <dl>
1052
1052
  <dd>
1053
1053
 
1054
- **request:** `Extend.ProcessorCreateRequest`
1054
+ **workflowRunId:** `string`
1055
+
1056
+ The ID of the WorkflowRun that was outputted after a Workflow was run through the API.
1057
+
1058
+ Example: `"workflow_run_8k9m-xyzAB_Pqrst-Nvw4"`
1055
1059
 
1056
1060
  </dd>
1057
1061
  </dl>
@@ -1059,7 +1063,7 @@ await client.processor.create({
1059
1063
  <dl>
1060
1064
  <dd>
1061
1065
 
1062
- **requestOptions:** `Processor.RequestOptions`
1066
+ **requestOptions:** `WorkflowRun.RequestOptions`
1063
1067
 
1064
1068
  </dd>
1065
1069
  </dl>
@@ -1070,7 +1074,7 @@ await client.processor.create({
1070
1074
  </dl>
1071
1075
  </details>
1072
1076
 
1073
- <details><summary><code>client.processor.<a href="/src/api/resources/processor/client/Client.ts">update</a>(id, { ...params }) -> Extend.ProcessorUpdateResponse</code></summary>
1077
+ <details><summary><code>client.workflowRun.<a href="/src/api/resources/workflowRun/client/Client.ts">update</a>(workflowRunId, { ...params }) -> Extend.WorkflowRunUpdateResponse</code></summary>
1074
1078
  <dl>
1075
1079
  <dd>
1076
1080
 
@@ -1082,7 +1086,7 @@ await client.processor.create({
1082
1086
  <dl>
1083
1087
  <dd>
1084
1088
 
1085
- Update an existing processor in Extend
1089
+ You can update the name and metadata of an in progress WorkflowRun at any time using this endpoint.
1086
1090
 
1087
1091
  </dd>
1088
1092
  </dl>
@@ -1098,7 +1102,7 @@ Update an existing processor in Extend
1098
1102
  <dd>
1099
1103
 
1100
1104
  ```typescript
1101
- await client.processor.update("processor_id_here");
1105
+ await client.workflowRun.update("workflow_run_id_here");
1102
1106
  ```
1103
1107
 
1104
1108
  </dd>
@@ -1114,11 +1118,11 @@ await client.processor.update("processor_id_here");
1114
1118
  <dl>
1115
1119
  <dd>
1116
1120
 
1117
- **id:** `string`
1121
+ **workflowRunId:** `string`
1118
1122
 
1119
- The ID of the processor to update.
1123
+ The ID of the WorkflowRun. This ID will start with "workflow_run". This ID can be found in the API response when creating a Workflow Run, or in the "history" tab of a workflow on the Extend platform.
1120
1124
 
1121
- Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
1125
+ Example: `"workflow_run_8k9m-xyzAB_Pqrst-Nvw4"`
1122
1126
 
1123
1127
  </dd>
1124
1128
  </dl>
@@ -1126,7 +1130,7 @@ Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
1126
1130
  <dl>
1127
1131
  <dd>
1128
1132
 
1129
- **request:** `Extend.ProcessorUpdateRequest`
1133
+ **request:** `Extend.WorkflowRunUpdateRequest`
1130
1134
 
1131
1135
  </dd>
1132
1136
  </dl>
@@ -1134,7 +1138,7 @@ Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
1134
1138
  <dl>
1135
1139
  <dd>
1136
1140
 
1137
- **requestOptions:** `Processor.RequestOptions`
1141
+ **requestOptions:** `WorkflowRun.RequestOptions`
1138
1142
 
1139
1143
  </dd>
1140
1144
  </dl>
@@ -1145,9 +1149,7 @@ Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
1145
1149
  </dl>
1146
1150
  </details>
1147
1151
 
1148
- ## ProcessorVersion
1149
-
1150
- <details><summary><code>client.processorVersion.<a href="/src/api/resources/processorVersion/client/Client.ts">get</a>(processorId, processorVersionId) -> Extend.ProcessorVersionGetResponse</code></summary>
1152
+ <details><summary><code>client.workflowRun.<a href="/src/api/resources/workflowRun/client/Client.ts">delete</a>(workflowRunId) -> Extend.WorkflowRunDeleteResponse</code></summary>
1151
1153
  <dl>
1152
1154
  <dd>
1153
1155
 
@@ -1159,7 +1161,9 @@ Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
1159
1161
  <dl>
1160
1162
  <dd>
1161
1163
 
1162
- Retrieve a specific version of a processor in Extend
1164
+ Delete a workflow run and all associated data from Extend. This operation is permanent and cannot be undone.
1165
+
1166
+ This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.
1163
1167
 
1164
1168
  </dd>
1165
1169
  </dl>
@@ -1175,7 +1179,7 @@ Retrieve a specific version of a processor in Extend
1175
1179
  <dd>
1176
1180
 
1177
1181
  ```typescript
1178
- await client.processorVersion.get("processor_id_here", "processor_version_id_here");
1182
+ await client.workflowRun.delete("workflow_run_id_here");
1179
1183
  ```
1180
1184
 
1181
1185
  </dd>
@@ -1191,23 +1195,11 @@ await client.processorVersion.get("processor_id_here", "processor_version_id_her
1191
1195
  <dl>
1192
1196
  <dd>
1193
1197
 
1194
- **processorId:** `string`
1195
-
1196
- The ID of the processor.
1197
-
1198
- Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
1199
-
1200
- </dd>
1201
- </dl>
1202
-
1203
- <dl>
1204
- <dd>
1205
-
1206
- **processorVersionId:** `string`
1198
+ **workflowRunId:** `string`
1207
1199
 
1208
- The ID of the specific processor version to retrieve.
1200
+ The ID of the workflow run to delete.
1209
1201
 
1210
- Example: `"dpv_QYk6jgHA_8CsO8rVWhyNC"`
1202
+ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
1211
1203
 
1212
1204
  </dd>
1213
1205
  </dl>
@@ -1215,7 +1207,7 @@ Example: `"dpv_QYk6jgHA_8CsO8rVWhyNC"`
1215
1207
  <dl>
1216
1208
  <dd>
1217
1209
 
1218
- **requestOptions:** `ProcessorVersion.RequestOptions`
1210
+ **requestOptions:** `WorkflowRun.RequestOptions`
1219
1211
 
1220
1212
  </dd>
1221
1213
  </dl>
@@ -1226,7 +1218,7 @@ Example: `"dpv_QYk6jgHA_8CsO8rVWhyNC"`
1226
1218
  </dl>
1227
1219
  </details>
1228
1220
 
1229
- <details><summary><code>client.processorVersion.<a href="/src/api/resources/processorVersion/client/Client.ts">list</a>(id) -> Extend.ProcessorVersionListResponse</code></summary>
1221
+ <details><summary><code>client.workflowRun.<a href="/src/api/resources/workflowRun/client/Client.ts">cancel</a>(workflowRunId) -> Extend.WorkflowRunCancelResponse</code></summary>
1230
1222
  <dl>
1231
1223
  <dd>
1232
1224
 
@@ -1238,10 +1230,9 @@ Example: `"dpv_QYk6jgHA_8CsO8rVWhyNC"`
1238
1230
  <dl>
1239
1231
  <dd>
1240
1232
 
1241
- This endpoint allows you to fetch all versions of a given processor, including the current `draft` version.
1233
+ Cancel a running workflow run by its ID. This endpoint allows you to stop a workflow run that is currently in progress.
1242
1234
 
1243
- Versions are typically returned in descending order of creation (newest first), but this should be confirmed in the actual implementation.
1244
- The `draft` version is the latest unpublished version of the processor, which can be published to create a new version. It might not have any changes from the last published version.
1235
+ Note: Only workflow runs with a status of `PROCESSING` or `PENDING` can be cancelled. Workflow runs that are completed, failed, in review, rejected, or already cancelled cannot be cancelled.
1245
1236
 
1246
1237
  </dd>
1247
1238
  </dl>
@@ -1257,7 +1248,7 @@ The `draft` version is the latest unpublished version of the processor, which ca
1257
1248
  <dd>
1258
1249
 
1259
1250
  ```typescript
1260
- await client.processorVersion.list("processor_id_here");
1251
+ await client.workflowRun.cancel("workflow_run_id_here");
1261
1252
  ```
1262
1253
 
1263
1254
  </dd>
@@ -1273,11 +1264,11 @@ await client.processorVersion.list("processor_id_here");
1273
1264
  <dl>
1274
1265
  <dd>
1275
1266
 
1276
- **id:** `string`
1267
+ **workflowRunId:** `string`
1277
1268
 
1278
- The ID of the processor to retrieve versions for.
1269
+ The ID of the workflow run to cancel.
1279
1270
 
1280
- Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
1271
+ Example: `"workflow_run_xKm9pNv3qWsY_jL2tR5Dh"`
1281
1272
 
1282
1273
  </dd>
1283
1274
  </dl>
@@ -1285,7 +1276,7 @@ Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
1285
1276
  <dl>
1286
1277
  <dd>
1287
1278
 
1288
- **requestOptions:** `ProcessorVersion.RequestOptions`
1279
+ **requestOptions:** `WorkflowRun.RequestOptions`
1289
1280
 
1290
1281
  </dd>
1291
1282
  </dl>
@@ -1296,7 +1287,9 @@ Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
1296
1287
  </dl>
1297
1288
  </details>
1298
1289
 
1299
- <details><summary><code>client.processorVersion.<a href="/src/api/resources/processorVersion/client/Client.ts">create</a>(id, { ...params }) -> Extend.ProcessorVersionCreateResponse</code></summary>
1290
+ ## WorkflowRunOutput
1291
+
1292
+ <details><summary><code>client.workflowRunOutput.<a href="/src/api/resources/workflowRunOutput/client/Client.ts">update</a>(workflowRunId, outputId, { ...params }) -> Extend.WorkflowRunOutputUpdateResponse</code></summary>
1300
1293
  <dl>
1301
1294
  <dd>
1302
1295
 
@@ -1308,9 +1301,11 @@ Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
1308
1301
  <dl>
1309
1302
  <dd>
1310
1303
 
1311
- This endpoint allows you to publish a new version of an existing processor. Publishing a new version creates a snapshot of the processor's current configuration and makes it available for use in workflows.
1304
+ Use this endpoint to submit corrected outputs for a WorkflowRun for future processor evaluation and tuning in Extend.
1312
1305
 
1313
- Publishing a new version does not automatically update existing workflows using this processor. You may need to manually update workflows to use the new version if desired.
1306
+ If you are using our Human-in-the-loop workflow review, then we already will be collecting your operator submitted corrections. However, if you are receiving data via the API without human review, there could be incorrect outputs that you would like to correct for future usage in evaluation and tuning within the Extend platform. This endpoint allows you to submit corrected outputs for a WorkflowRun, by providing the correct output for a given output ID.
1307
+
1308
+ The output ID, would be found in a given entry within the outputs arrays of a Workflow Run payload. The ID would look something like `dpr_gwkZZNRrPgkjcq0y-***`.
1314
1309
 
1315
1310
  </dd>
1316
1311
  </dl>
@@ -1326,8 +1321,12 @@ Publishing a new version does not automatically update existing workflows using
1326
1321
  <dd>
1327
1322
 
1328
1323
  ```typescript
1329
- await client.processorVersion.create("processor_id_here", {
1330
- releaseType: "major",
1324
+ await client.workflowRunOutput.update("workflow_run_id_here", "output_id_here", {
1325
+ reviewedOutput: {
1326
+ value: {
1327
+ key: "value",
1328
+ },
1329
+ },
1331
1330
  });
1332
1331
  ```
1333
1332
 
@@ -1344,11 +1343,15 @@ await client.processorVersion.create("processor_id_here", {
1344
1343
  <dl>
1345
1344
  <dd>
1346
1345
 
1347
- **id:** `string`
1346
+ **workflowRunId:** `string`
1348
1347
 
1349
- The ID of the processor to publish a new version for.
1348
+ </dd>
1349
+ </dl>
1350
1350
 
1351
- Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
1351
+ <dl>
1352
+ <dd>
1353
+
1354
+ **outputId:** `string`
1352
1355
 
1353
1356
  </dd>
1354
1357
  </dl>
@@ -1356,7 +1359,7 @@ Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
1356
1359
  <dl>
1357
1360
  <dd>
1358
1361
 
1359
- **request:** `Extend.ProcessorVersionCreateRequest`
1362
+ **request:** `Extend.WorkflowRunOutputUpdateRequest`
1360
1363
 
1361
1364
  </dd>
1362
1365
  </dl>
@@ -1364,7 +1367,7 @@ Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
1364
1367
  <dl>
1365
1368
  <dd>
1366
1369
 
1367
- **requestOptions:** `ProcessorVersion.RequestOptions`
1370
+ **requestOptions:** `WorkflowRunOutput.RequestOptions`
1368
1371
 
1369
1372
  </dd>
1370
1373
  </dl>
@@ -1375,9 +1378,9 @@ Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
1375
1378
  </dl>
1376
1379
  </details>
1377
1380
 
1378
- ## ParserRun
1381
+ ## BatchWorkflowRun
1379
1382
 
1380
- <details><summary><code>client.parserRun.<a href="/src/api/resources/parserRun/client/Client.ts">get</a>(id, { ...params }) -> Extend.ParserRunGetResponse</code></summary>
1383
+ <details><summary><code>client.batchWorkflowRun.<a href="/src/api/resources/batchWorkflowRun/client/Client.ts">create</a>({ ...params }) -> Extend.BatchWorkflowRunCreateResponse</code></summary>
1381
1384
  <dl>
1382
1385
  <dd>
1383
1386
 
@@ -1389,16 +1392,23 @@ Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
1389
1392
  <dl>
1390
1393
  <dd>
1391
1394
 
1392
- Retrieve the status and results of a parser run.
1395
+ 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.
1393
1396
 
1394
- Use this endpoint to get results for a parser run that has already completed, or to check on the status of an asynchronous parser run initiated via the [Parse File Asynchronously](https://docs.extend.ai/2025-04-21/developers/api-reference/parse-endpoints/parse-file-async) endpoint.
1397
+ Unlike the single [Run Workflow](/developers/api-reference/workflow-endpoints/run-workflow) endpoint which returns the details of the created workflow runs immediately, this batch endpoint returns a `batchId`.
1395
1398
 
1396
- If parsing is still in progress, you'll receive a response with just the status. Once complete, you'll receive the full parsed content in the response.
1399
+ Our recommended usage pattern is to integrate with [Webhooks](/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/2025-04-21/developers/api-reference/workflow-endpoints/list-workflow-runs) endpoint to fetch all runs via a batch, and then [Get Workflow Run](https://docs.extend.ai/2025-04-21/developers/api-reference/workflow-endpoints/get-workflow-run) to fetch the full outputs each run.
1397
1400
 
1398
- </dd>
1399
- </dl>
1400
- </dd>
1401
- </dl>
1401
+ **Priority:** All workflow runs created through this batch endpoint are automatically assigned a priority of 90.
1402
+
1403
+ **Processing and Monitoring:**
1404
+ Upon successful submission, the endpoint returns a `batchId`. The individual workflow runs are then queued for processing.
1405
+
1406
+ - **Monitoring:** Track the progress and consume results of individual runs using [Webhooks](/product/webhooks/configuration). Subscribe to events like `workflow_run.completed`, `workflow_run.failed`, etc. The webhook payload for these events will include the corresponding `batchId` and the `metadata` you provided for each input.
1407
+ - **Fetching Results:** You can also use the [List Workflow Runs](https://docs.extend.ai/2025-04-21/developers/api-reference/workflow-endpoints/list-workflow-runs) endpoint and filter using the `batchId` query param.
1408
+ </dd>
1409
+ </dl>
1410
+ </dd>
1411
+ </dl>
1402
1412
 
1403
1413
  #### 🔌 Usage
1404
1414
 
@@ -1409,8 +1419,9 @@ If parsing is still in progress, you'll receive a response with just the status.
1409
1419
  <dd>
1410
1420
 
1411
1421
  ```typescript
1412
- await client.parserRun.get("parser_run_id_here", {
1413
- responseType: "json",
1422
+ await client.batchWorkflowRun.create({
1423
+ workflowId: "workflow_id_here",
1424
+ inputs: [{}],
1414
1425
  });
1415
1426
  ```
1416
1427
 
@@ -1427,19 +1438,7 @@ await client.parserRun.get("parser_run_id_here", {
1427
1438
  <dl>
1428
1439
  <dd>
1429
1440
 
1430
- **id:** `string`
1431
-
1432
- The unique identifier for the parser run.
1433
-
1434
- Example: `"parser_run_xK9mLPqRtN3vS8wF5hB2cQ"`
1435
-
1436
- </dd>
1437
- </dl>
1438
-
1439
- <dl>
1440
- <dd>
1441
-
1442
- **request:** `Extend.ParserRunGetRequest`
1441
+ **request:** `Extend.BatchWorkflowRunCreateRequest`
1443
1442
 
1444
1443
  </dd>
1445
1444
  </dl>
@@ -1447,7 +1446,7 @@ Example: `"parser_run_xK9mLPqRtN3vS8wF5hB2cQ"`
1447
1446
  <dl>
1448
1447
  <dd>
1449
1448
 
1450
- **requestOptions:** `ParserRun.RequestOptions`
1449
+ **requestOptions:** `BatchWorkflowRun.RequestOptions`
1451
1450
 
1452
1451
  </dd>
1453
1452
  </dl>
@@ -1458,7 +1457,9 @@ Example: `"parser_run_xK9mLPqRtN3vS8wF5hB2cQ"`
1458
1457
  </dl>
1459
1458
  </details>
1460
1459
 
1461
- <details><summary><code>client.parserRun.<a href="/src/api/resources/parserRun/client/Client.ts">delete</a>(id) -> Extend.ParserRunDeleteResponse</code></summary>
1460
+ ## BatchProcessorRun
1461
+
1462
+ <details><summary><code>client.batchProcessorRun.<a href="/src/api/resources/batchProcessorRun/client/Client.ts">get</a>(id) -> Extend.BatchProcessorRunGetResponse</code></summary>
1462
1463
  <dl>
1463
1464
  <dd>
1464
1465
 
@@ -1470,9 +1471,7 @@ Example: `"parser_run_xK9mLPqRtN3vS8wF5hB2cQ"`
1470
1471
  <dl>
1471
1472
  <dd>
1472
1473
 
1473
- Delete a parser run and all associated data from Extend. This operation is permanent and cannot be undone.
1474
-
1475
- This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.
1474
+ Retrieve details about a batch processor run, including evaluation runs
1476
1475
 
1477
1476
  </dd>
1478
1477
  </dl>
@@ -1488,7 +1487,7 @@ This endpoint can be used if you'd like to manage data retention on your own rat
1488
1487
  <dd>
1489
1488
 
1490
1489
  ```typescript
1491
- await client.parserRun.delete("parser_run_id_here");
1490
+ await client.batchProcessorRun.get("batch_processor_run_id_here");
1492
1491
  ```
1493
1492
 
1494
1493
  </dd>
@@ -1506,9 +1505,9 @@ await client.parserRun.delete("parser_run_id_here");
1506
1505
 
1507
1506
  **id:** `string`
1508
1507
 
1509
- The ID of the parser run to delete.
1508
+ The unique identifier of the batch processor run to retrieve. The ID will always start with "bpr\_".
1510
1509
 
1511
- Example: `"parser_run_xK9mLPqRtN3vS8wF5hB2cQ"`
1510
+ Example: `"bpr_Xj8mK2pL9nR4vT7qY5wZ"`
1512
1511
 
1513
1512
  </dd>
1514
1513
  </dl>
@@ -1516,7 +1515,7 @@ Example: `"parser_run_xK9mLPqRtN3vS8wF5hB2cQ"`
1516
1515
  <dl>
1517
1516
  <dd>
1518
1517
 
1519
- **requestOptions:** `ParserRun.RequestOptions`
1518
+ **requestOptions:** `BatchProcessorRun.RequestOptions`
1520
1519
 
1521
1520
  </dd>
1522
1521
  </dl>
@@ -1527,9 +1526,9 @@ Example: `"parser_run_xK9mLPqRtN3vS8wF5hB2cQ"`
1527
1526
  </dl>
1528
1527
  </details>
1529
1528
 
1530
- ## Edit
1529
+ ## EvaluationSet
1531
1530
 
1532
- <details><summary><code>client.edit.<a href="/src/api/resources/edit/client/Client.ts">create</a>({ ...params }) -> Extend.EditRun</code></summary>
1531
+ <details><summary><code>client.evaluationSet.<a href="/src/api/resources/evaluationSet/client/Client.ts">list</a>({ ...params }) -> Extend.EvaluationSetListResponse</code></summary>
1533
1532
  <dl>
1534
1533
  <dd>
1535
1534
 
@@ -1541,8 +1540,9 @@ Example: `"parser_run_xK9mLPqRtN3vS8wF5hB2cQ"`
1541
1540
  <dl>
1542
1541
  <dd>
1543
1542
 
1544
- Edit and manipulate PDF documents by detecting and filling form fields.
1545
- This is a synchronous endpoint that will wait for the edit operation to complete (up to 5 minutes) before returning results. For longer operations, use the [Edit File Async](/developers/api-reference/edit-endpoints/edit-file-async) endpoint.
1543
+ List evaluation sets in your account. You can use the `processorId` parameter to filter evaluation sets by processor.
1544
+
1545
+ This endpoint returns a paginated response. You can use the `nextPageToken` to fetch subsequent results.
1546
1546
 
1547
1547
  </dd>
1548
1548
  </dl>
@@ -1558,8 +1558,12 @@ This is a synchronous endpoint that will wait for the edit operation to complete
1558
1558
  <dd>
1559
1559
 
1560
1560
  ```typescript
1561
- await client.edit.create({
1562
- file: {},
1561
+ await client.evaluationSet.list({
1562
+ processorId: "processor_id_here",
1563
+ sortBy: "updatedAt",
1564
+ sortDir: "asc",
1565
+ nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ=",
1566
+ maxPageSize: 1,
1563
1567
  });
1564
1568
  ```
1565
1569
 
@@ -1576,7 +1580,7 @@ await client.edit.create({
1576
1580
  <dl>
1577
1581
  <dd>
1578
1582
 
1579
- **request:** `Extend.EditCreateRequest`
1583
+ **request:** `Extend.EvaluationSetListRequest`
1580
1584
 
1581
1585
  </dd>
1582
1586
  </dl>
@@ -1584,7 +1588,7 @@ await client.edit.create({
1584
1588
  <dl>
1585
1589
  <dd>
1586
1590
 
1587
- **requestOptions:** `Edit.RequestOptions`
1591
+ **requestOptions:** `EvaluationSet.RequestOptions`
1588
1592
 
1589
1593
  </dd>
1590
1594
  </dl>
@@ -1595,7 +1599,7 @@ await client.edit.create({
1595
1599
  </dl>
1596
1600
  </details>
1597
1601
 
1598
- <details><summary><code>client.edit.<a href="/src/api/resources/edit/client/Client.ts">createAsync</a>({ ...params }) -> Extend.EditRunStatus</code></summary>
1602
+ <details><summary><code>client.evaluationSet.<a href="/src/api/resources/evaluationSet/client/Client.ts">create</a>({ ...params }) -> Extend.EvaluationSetCreateResponse</code></summary>
1599
1603
  <dl>
1600
1604
  <dd>
1601
1605
 
@@ -1607,19 +1611,14 @@ await client.edit.create({
1607
1611
  <dl>
1608
1612
  <dd>
1609
1613
 
1610
- Edit and manipulate PDF documents **asynchronously** by filling forms, adding/modifying text fields, and applying structured changes.
1611
-
1612
- The Edit Async endpoint allows you to convert and edit documents asynchronously and get an edit run ID that can be used to check status and retrieve results with the [Get Edit Run](/developers/api-reference/edit-endpoints/get-edit-run) endpoint.
1614
+ Evaluation sets are collections of files and expected outputs that are used to evaluate the performance of a given processor in Extend. This endpoint will create a new evaluation set in Extend, which items can be added to using the [Create Evaluation Set Item](https://docs.extend.ai/2025-04-21/developers/api-reference/evaluation-set-endpoints/create-evaluation-set-item) endpoint.
1613
1615
 
1614
- This is useful for:
1616
+ 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.
1615
1617
 
1616
- - Large files that may take longer to process
1617
- - Avoiding timeout issues with synchronous editing
1618
- - Processing multiple files in parallel
1619
- </dd>
1620
- </dl>
1621
- </dd>
1622
- </dl>
1618
+ </dd>
1619
+ </dl>
1620
+ </dd>
1621
+ </dl>
1623
1622
 
1624
1623
  #### 🔌 Usage
1625
1624
 
@@ -1630,8 +1629,10 @@ This is useful for:
1630
1629
  <dd>
1631
1630
 
1632
1631
  ```typescript
1633
- await client.edit.createAsync({
1634
- file: {},
1632
+ await client.evaluationSet.create({
1633
+ name: "My Evaluation Set",
1634
+ description: "My Evaluation Set Description",
1635
+ processorId: "processor_id_here",
1635
1636
  });
1636
1637
  ```
1637
1638
 
@@ -1648,7 +1649,7 @@ await client.edit.createAsync({
1648
1649
  <dl>
1649
1650
  <dd>
1650
1651
 
1651
- **request:** `Extend.EditCreateAsyncRequest`
1652
+ **request:** `Extend.EvaluationSetCreateRequest`
1652
1653
 
1653
1654
  </dd>
1654
1655
  </dl>
@@ -1656,7 +1657,7 @@ await client.edit.createAsync({
1656
1657
  <dl>
1657
1658
  <dd>
1658
1659
 
1659
- **requestOptions:** `Edit.RequestOptions`
1660
+ **requestOptions:** `EvaluationSet.RequestOptions`
1660
1661
 
1661
1662
  </dd>
1662
1663
  </dl>
@@ -1667,7 +1668,7 @@ await client.edit.createAsync({
1667
1668
  </dl>
1668
1669
  </details>
1669
1670
 
1670
- <details><summary><code>client.edit.<a href="/src/api/resources/edit/client/Client.ts">get</a>(id) -> Extend.EditGetResponse</code></summary>
1671
+ <details><summary><code>client.evaluationSet.<a href="/src/api/resources/evaluationSet/client/Client.ts">get</a>(id) -> Extend.EvaluationSetGetResponse</code></summary>
1671
1672
  <dl>
1672
1673
  <dd>
1673
1674
 
@@ -1679,11 +1680,7 @@ await client.edit.createAsync({
1679
1680
  <dl>
1680
1681
  <dd>
1681
1682
 
1682
- Retrieve the status and results of an edit run.
1683
-
1684
- Use this endpoint to get results for an edit run that has already completed, or to check on the status of an asynchronous edit run initiated via the [Edit File Asynchronously](/developers/api-reference/edit-endpoints/edit-file-async) endpoint.
1685
-
1686
- If editing is still in progress, you'll receive a response with just the status. Once complete, you'll receive the full edited file information in the response.
1683
+ Retrieve a specific evaluation set by ID. This returns an evaluation set object, but does not include the items in the evaluation set. You can use the [List Evaluation Set Items](https://docs.extend.ai/2025-04-21/developers/api-reference/evaluation-set-endpoints/list-evaluation-set-items) endpoint to get the items in an evaluation set.
1687
1684
 
1688
1685
  </dd>
1689
1686
  </dl>
@@ -1699,7 +1696,7 @@ If editing is still in progress, you'll receive a response with just the status.
1699
1696
  <dd>
1700
1697
 
1701
1698
  ```typescript
1702
- await client.edit.get("edit_run_id_here");
1699
+ await client.evaluationSet.get("evaluation_set_id_here");
1703
1700
  ```
1704
1701
 
1705
1702
  </dd>
@@ -1717,9 +1714,9 @@ await client.edit.get("edit_run_id_here");
1717
1714
 
1718
1715
  **id:** `string`
1719
1716
 
1720
- The unique identifier for the edit run.
1717
+ The ID of the evaluation set to retrieve.
1721
1718
 
1722
- Example: `"edit_run_xK9mLPqRtN3vS8wF5hB2cQ"`
1719
+ Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
1723
1720
 
1724
1721
  </dd>
1725
1722
  </dl>
@@ -1727,7 +1724,7 @@ Example: `"edit_run_xK9mLPqRtN3vS8wF5hB2cQ"`
1727
1724
  <dl>
1728
1725
  <dd>
1729
1726
 
1730
- **requestOptions:** `Edit.RequestOptions`
1727
+ **requestOptions:** `EvaluationSet.RequestOptions`
1731
1728
 
1732
1729
  </dd>
1733
1730
  </dl>
@@ -1738,7 +1735,9 @@ Example: `"edit_run_xK9mLPqRtN3vS8wF5hB2cQ"`
1738
1735
  </dl>
1739
1736
  </details>
1740
1737
 
1741
- <details><summary><code>client.edit.<a href="/src/api/resources/edit/client/Client.ts">delete</a>(id) -> Extend.EditDeleteResponse</code></summary>
1738
+ ## EvaluationSetItem
1739
+
1740
+ <details><summary><code>client.evaluationSetItem.<a href="/src/api/resources/evaluationSetItem/client/Client.ts">list</a>(id, { ...params }) -> Extend.EvaluationSetItemListResponse</code></summary>
1742
1741
  <dl>
1743
1742
  <dd>
1744
1743
 
@@ -1750,9 +1749,9 @@ Example: `"edit_run_xK9mLPqRtN3vS8wF5hB2cQ"`
1750
1749
  <dl>
1751
1750
  <dd>
1752
1751
 
1753
- Delete an edit run and all associated data from Extend. This operation is permanent and cannot be undone.
1752
+ List all items in a specific evaluation set. Evaluation set items are the individual files and expected outputs that are used to evaluate the performance of a given processor in Extend.
1754
1753
 
1755
- This endpoint can be used if you'd like to manage data retention on your own rather than relying on automated data retention policies, or to make one-off deletions for your downstream customers.
1754
+ This endpoint returns a paginated response. You can use the `nextPageToken` to fetch subsequent results.
1756
1755
 
1757
1756
  </dd>
1758
1757
  </dl>
@@ -1768,7 +1767,12 @@ This endpoint can be used if you'd like to manage data retention on your own rat
1768
1767
  <dd>
1769
1768
 
1770
1769
  ```typescript
1771
- await client.edit.delete("edit_run_id_here");
1770
+ await client.evaluationSetItem.list("evaluation_set_id_here", {
1771
+ sortBy: "updatedAt",
1772
+ sortDir: "asc",
1773
+ nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ=",
1774
+ maxPageSize: 1,
1775
+ });
1772
1776
  ```
1773
1777
 
1774
1778
  </dd>
@@ -1786,9 +1790,9 @@ await client.edit.delete("edit_run_id_here");
1786
1790
 
1787
1791
  **id:** `string`
1788
1792
 
1789
- The ID of the edit run to delete.
1793
+ The ID of the evaluation set to retrieve items for.
1790
1794
 
1791
- Example: `"edit_run_xK9mLPqRtN3vS8wF5hB2cQ"`
1795
+ Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
1792
1796
 
1793
1797
  </dd>
1794
1798
  </dl>
@@ -1796,7 +1800,15 @@ Example: `"edit_run_xK9mLPqRtN3vS8wF5hB2cQ"`
1796
1800
  <dl>
1797
1801
  <dd>
1798
1802
 
1799
- **requestOptions:** `Edit.RequestOptions`
1803
+ **request:** `Extend.EvaluationSetItemListRequest`
1804
+
1805
+ </dd>
1806
+ </dl>
1807
+
1808
+ <dl>
1809
+ <dd>
1810
+
1811
+ **requestOptions:** `EvaluationSetItem.RequestOptions`
1800
1812
 
1801
1813
  </dd>
1802
1814
  </dl>
@@ -1807,9 +1819,7 @@ Example: `"edit_run_xK9mLPqRtN3vS8wF5hB2cQ"`
1807
1819
  </dl>
1808
1820
  </details>
1809
1821
 
1810
- ## File
1811
-
1812
- <details><summary><code>client.file.<a href="/src/api/resources/file/client/Client.ts">list</a>({ ...params }) -> Extend.FileListResponse</code></summary>
1822
+ <details><summary><code>client.evaluationSetItem.<a href="/src/api/resources/evaluationSetItem/client/Client.ts">create</a>({ ...params }) -> Extend.EvaluationSetItemCreateResponse</code></summary>
1813
1823
  <dl>
1814
1824
  <dd>
1815
1825
 
@@ -1821,12 +1831,25 @@ Example: `"edit_run_xK9mLPqRtN3vS8wF5hB2cQ"`
1821
1831
  <dl>
1822
1832
  <dd>
1823
1833
 
1824
- List files in your account. Files represent documents that have been uploaded to Extend. This endpoint returns a paginated response. You can use the `nextPageToken` to fetch subsequent results.
1834
+ Evaluation set items are the individual files and expected outputs that are used to evaluate the performance of a given processor in Extend. This endpoint will create a new evaluation set item in Extend, which will be used during an evaluation run.
1825
1835
 
1826
- </dd>
1827
- </dl>
1828
- </dd>
1829
- </dl>
1836
+ Best Practices for Outputs in Evaluation Sets:
1837
+
1838
+ - **Configure First, Output Later**
1839
+ - Always create and finalize your processor configuration before creating evaluation sets
1840
+ - Field IDs in outputs must match those defined in your processor configuration
1841
+ - **Type Consistency**
1842
+ - Ensure output types exactly match your processor configuration
1843
+ - For example, if a field is configured as "currency", don't submit a simple number value
1844
+ - **Field IDs**
1845
+ - Use the exact field IDs from your processor configuration
1846
+ - Create your own semantic IDs instead in the configs for each field/type instead of using the generated ones
1847
+ - **Value**
1848
+ - Remember that all results are inside the value key of a result object, except the values within nested structures.
1849
+ </dd>
1850
+ </dl>
1851
+ </dd>
1852
+ </dl>
1830
1853
 
1831
1854
  #### 🔌 Usage
1832
1855
 
@@ -1837,11 +1860,14 @@ List files in your account. Files represent documents that have been uploaded to
1837
1860
  <dd>
1838
1861
 
1839
1862
  ```typescript
1840
- await client.file.list({
1841
- nameContains: "nameContains",
1842
- sortDir: "asc",
1843
- nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ=",
1844
- maxPageSize: 1,
1863
+ await client.evaluationSetItem.create({
1864
+ evaluationSetId: "evaluation_set_id_here",
1865
+ fileId: "file_id_here",
1866
+ expectedOutput: {
1867
+ value: {
1868
+ key: "value",
1869
+ },
1870
+ },
1845
1871
  });
1846
1872
  ```
1847
1873
 
@@ -1858,7 +1884,7 @@ await client.file.list({
1858
1884
  <dl>
1859
1885
  <dd>
1860
1886
 
1861
- **request:** `Extend.FileListRequest`
1887
+ **request:** `Extend.EvaluationSetItemCreateRequest`
1862
1888
 
1863
1889
  </dd>
1864
1890
  </dl>
@@ -1866,7 +1892,7 @@ await client.file.list({
1866
1892
  <dl>
1867
1893
  <dd>
1868
1894
 
1869
- **requestOptions:** `File_.RequestOptions`
1895
+ **requestOptions:** `EvaluationSetItem.RequestOptions`
1870
1896
 
1871
1897
  </dd>
1872
1898
  </dl>
@@ -1877,7 +1903,7 @@ await client.file.list({
1877
1903
  </dl>
1878
1904
  </details>
1879
1905
 
1880
- <details><summary><code>client.file.<a href="/src/api/resources/file/client/Client.ts">get</a>(id, { ...params }) -> Extend.FileGetResponse</code></summary>
1906
+ <details><summary><code>client.evaluationSetItem.<a href="/src/api/resources/evaluationSetItem/client/Client.ts">update</a>(id, { ...params }) -> Extend.EvaluationSetItemUpdateResponse</code></summary>
1881
1907
  <dl>
1882
1908
  <dd>
1883
1909
 
@@ -1889,7 +1915,7 @@ await client.file.list({
1889
1915
  <dl>
1890
1916
  <dd>
1891
1917
 
1892
- Fetch a file by its ID to obtain additional details and the raw file content.
1918
+ If you need to change the expected output for a given evaluation set item, you can use this endpoint to update the item. This can be useful if you need to correct an error in the expected output or if the output of the processor has changed.
1893
1919
 
1894
1920
  </dd>
1895
1921
  </dl>
@@ -1905,10 +1931,12 @@ Fetch a file by its ID to obtain additional details and the raw file content.
1905
1931
  <dd>
1906
1932
 
1907
1933
  ```typescript
1908
- await client.file.get("file_id_here", {
1909
- rawText: true,
1910
- markdown: true,
1911
- html: true,
1934
+ await client.evaluationSetItem.update("evaluation_set_item_id_here", {
1935
+ expectedOutput: {
1936
+ value: {
1937
+ key: "value",
1938
+ },
1939
+ },
1912
1940
  });
1913
1941
  ```
1914
1942
 
@@ -1927,9 +1955,9 @@ await client.file.get("file_id_here", {
1927
1955
 
1928
1956
  **id:** `string`
1929
1957
 
1930
- Extend's ID for the file. It will always start with `"file_"`. This ID is returned when creating a new File, or the value on the `fileId` field in a WorkflowRun.
1958
+ The ID of the evaluation set item to update.
1931
1959
 
1932
- Example: `"file_Xj8mK2pL9nR4vT7qY5wZ"`
1960
+ Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
1933
1961
 
1934
1962
  </dd>
1935
1963
  </dl>
@@ -1937,7 +1965,7 @@ Example: `"file_Xj8mK2pL9nR4vT7qY5wZ"`
1937
1965
  <dl>
1938
1966
  <dd>
1939
1967
 
1940
- **request:** `Extend.FileGetRequest`
1968
+ **request:** `Extend.EvaluationSetItemUpdateRequest`
1941
1969
 
1942
1970
  </dd>
1943
1971
  </dl>
@@ -1945,7 +1973,7 @@ Example: `"file_Xj8mK2pL9nR4vT7qY5wZ"`
1945
1973
  <dl>
1946
1974
  <dd>
1947
1975
 
1948
- **requestOptions:** `File_.RequestOptions`
1976
+ **requestOptions:** `EvaluationSetItem.RequestOptions`
1949
1977
 
1950
1978
  </dd>
1951
1979
  </dl>
@@ -1956,7 +1984,7 @@ Example: `"file_Xj8mK2pL9nR4vT7qY5wZ"`
1956
1984
  </dl>
1957
1985
  </details>
1958
1986
 
1959
- <details><summary><code>client.file.<a href="/src/api/resources/file/client/Client.ts">delete</a>(id) -> Extend.FileDeleteResponse</code></summary>
1987
+ <details><summary><code>client.evaluationSetItem.<a href="/src/api/resources/evaluationSetItem/client/Client.ts">delete</a>(id) -> Extend.EvaluationSetItemDeleteResponse</code></summary>
1960
1988
  <dl>
1961
1989
  <dd>
1962
1990
 
@@ -1968,9 +1996,9 @@ Example: `"file_Xj8mK2pL9nR4vT7qY5wZ"`
1968
1996
  <dl>
1969
1997
  <dd>
1970
1998
 
1971
- Delete a file and all associated data from Extend. This operation is permanent and cannot be undone.
1999
+ Delete an evaluation set item from an evaluation set. This operation is permanent and cannot be undone.
1972
2000
 
1973
- This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.
2001
+ This endpoint can be used to remove individual items from an evaluation set when they are no longer needed or if they were added in error.
1974
2002
 
1975
2003
  </dd>
1976
2004
  </dl>
@@ -1986,7 +2014,7 @@ This endpoint can be used if you'd like to manage data retention on your own rat
1986
2014
  <dd>
1987
2015
 
1988
2016
  ```typescript
1989
- await client.file.delete("file_id_here");
2017
+ await client.evaluationSetItem.delete("evaluation_set_item_id_here");
1990
2018
  ```
1991
2019
 
1992
2020
  </dd>
@@ -2004,9 +2032,9 @@ await client.file.delete("file_id_here");
2004
2032
 
2005
2033
  **id:** `string`
2006
2034
 
2007
- The ID of the file to delete.
2035
+ The ID of the evaluation set item to delete.
2008
2036
 
2009
- Example: `"file_xK9mLPqRtN3vS8wF5hB2cQ"`
2037
+ Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
2010
2038
 
2011
2039
  </dd>
2012
2040
  </dl>
@@ -2014,7 +2042,7 @@ Example: `"file_xK9mLPqRtN3vS8wF5hB2cQ"`
2014
2042
  <dl>
2015
2043
  <dd>
2016
2044
 
2017
- **requestOptions:** `File_.RequestOptions`
2045
+ **requestOptions:** `EvaluationSetItem.RequestOptions`
2018
2046
 
2019
2047
  </dd>
2020
2048
  </dl>
@@ -2025,7 +2053,7 @@ Example: `"file_xK9mLPqRtN3vS8wF5hB2cQ"`
2025
2053
  </dl>
2026
2054
  </details>
2027
2055
 
2028
- <details><summary><code>client.file.<a href="/src/api/resources/file/client/Client.ts">upload</a>(file) -> Extend.FileUploadResponse</code></summary>
2056
+ <details><summary><code>client.evaluationSetItem.<a href="/src/api/resources/evaluationSetItem/client/Client.ts">createBatch</a>({ ...params }) -> Extend.EvaluationSetItemCreateBatchResponse</code></summary>
2029
2057
  <dl>
2030
2058
  <dd>
2031
2059
 
@@ -2037,15 +2065,9 @@ Example: `"file_xK9mLPqRtN3vS8wF5hB2cQ"`
2037
2065
  <dl>
2038
2066
  <dd>
2039
2067
 
2040
- Upload and create a new file in Extend.
2041
-
2042
- This endpoint accepts file contents and registers them as a File in Extend, which can be used for [running workflows](https://docs.extend.ai/2025-04-21/developers/api-reference/workflow-endpoints/run-workflow), [creating evaluation set items](https://docs.extend.ai/2025-04-21/developers/api-reference/evaluation-set-endpoints/bulk-create-evaluation-set-items), [parsing](https://docs.extend.ai/2025-04-21/developers/api-reference/parse-endpoints/parse-file), etc.
2043
-
2044
- If an uploaded file is detected as a Word or PowerPoint document, it will be automatically converted to a PDF.
2045
-
2046
- Supported file types can be found [here](/product/general/supported-file-types).
2068
+ If you have a large number of files that you need to add to an evaluation set, you can use this endpoint to create multiple evaluation set items at once. This can be useful if you have a large dataset that you need to evaluate the performance of a processor against.
2047
2069
 
2048
- This endpoint requires multipart form encoding. Most HTTP clients will handle this encoding automatically (see the examples).
2070
+ Note: you still need to create each File first using the file API.
2049
2071
 
2050
2072
  </dd>
2051
2073
  </dl>
@@ -2061,7 +2083,19 @@ This endpoint requires multipart form encoding. Most HTTP clients will handle th
2061
2083
  <dd>
2062
2084
 
2063
2085
  ```typescript
2064
- await client.file.upload(createReadStream("path/to/file"));
2086
+ await client.evaluationSetItem.createBatch({
2087
+ evaluationSetId: "evaluation_set_id_here",
2088
+ items: [
2089
+ {
2090
+ fileId: "file_id_here",
2091
+ expectedOutput: {
2092
+ value: {
2093
+ key: "value",
2094
+ },
2095
+ },
2096
+ },
2097
+ ],
2098
+ });
2065
2099
  ```
2066
2100
 
2067
2101
  </dd>
@@ -2077,7 +2111,7 @@ await client.file.upload(createReadStream("path/to/file"));
2077
2111
  <dl>
2078
2112
  <dd>
2079
2113
 
2080
- **file:** `File | fs.ReadStream | Blob`
2114
+ **request:** `Extend.EvaluationSetItemCreateBatchRequest`
2081
2115
 
2082
2116
  </dd>
2083
2117
  </dl>
@@ -2085,7 +2119,7 @@ await client.file.upload(createReadStream("path/to/file"));
2085
2119
  <dl>
2086
2120
  <dd>
2087
2121
 
2088
- **requestOptions:** `File_.RequestOptions`
2122
+ **requestOptions:** `EvaluationSetItem.RequestOptions`
2089
2123
 
2090
2124
  </dd>
2091
2125
  </dl>
@@ -2096,9 +2130,9 @@ await client.file.upload(createReadStream("path/to/file"));
2096
2130
  </dl>
2097
2131
  </details>
2098
2132
 
2099
- ## EvaluationSet
2133
+ ## ProcessorRun
2100
2134
 
2101
- <details><summary><code>client.evaluationSet.<a href="/src/api/resources/evaluationSet/client/Client.ts">list</a>({ ...params }) -> Extend.EvaluationSetListResponse</code></summary>
2135
+ <details><summary><code>client.processorRun.<a href="/src/api/resources/processorRun/client/Client.ts">list</a>({ ...params }) -> Extend.ProcessorRunListResponse</code></summary>
2102
2136
  <dl>
2103
2137
  <dd>
2104
2138
 
@@ -2110,9 +2144,7 @@ await client.file.upload(createReadStream("path/to/file"));
2110
2144
  <dl>
2111
2145
  <dd>
2112
2146
 
2113
- List evaluation sets in your account. You can use the `processorId` parameter to filter evaluation sets by processor.
2114
-
2115
- This endpoint returns a paginated response. You can use the `nextPageToken` to fetch subsequent results.
2147
+ List runs of a Processor. A ProcessorRun represents a single execution of a processor against a file.
2116
2148
 
2117
2149
  </dd>
2118
2150
  </dl>
@@ -2128,8 +2160,13 @@ This endpoint returns a paginated response. You can use the `nextPageToken` to f
2128
2160
  <dd>
2129
2161
 
2130
2162
  ```typescript
2131
- await client.evaluationSet.list({
2132
- processorId: "processor_id_here",
2163
+ await client.processorRun.list({
2164
+ status: "PENDING",
2165
+ processorId: "processorId",
2166
+ processorType: "EXTRACT",
2167
+ sourceId: "sourceId",
2168
+ source: "ADMIN",
2169
+ fileNameContains: "fileNameContains",
2133
2170
  sortBy: "updatedAt",
2134
2171
  sortDir: "asc",
2135
2172
  nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ=",
@@ -2150,7 +2187,7 @@ await client.evaluationSet.list({
2150
2187
  <dl>
2151
2188
  <dd>
2152
2189
 
2153
- **request:** `Extend.EvaluationSetListRequest`
2190
+ **request:** `Extend.ProcessorRunListRequest`
2154
2191
 
2155
2192
  </dd>
2156
2193
  </dl>
@@ -2158,7 +2195,7 @@ await client.evaluationSet.list({
2158
2195
  <dl>
2159
2196
  <dd>
2160
2197
 
2161
- **requestOptions:** `EvaluationSet.RequestOptions`
2198
+ **requestOptions:** `ProcessorRun.RequestOptions`
2162
2199
 
2163
2200
  </dd>
2164
2201
  </dl>
@@ -2169,7 +2206,7 @@ await client.evaluationSet.list({
2169
2206
  </dl>
2170
2207
  </details>
2171
2208
 
2172
- <details><summary><code>client.evaluationSet.<a href="/src/api/resources/evaluationSet/client/Client.ts">create</a>({ ...params }) -> Extend.EvaluationSetCreateResponse</code></summary>
2209
+ <details><summary><code>client.processorRun.<a href="/src/api/resources/processorRun/client/Client.ts">create</a>({ ...params }) -> Extend.ProcessorRunCreateResponse</code></summary>
2173
2210
  <dl>
2174
2211
  <dd>
2175
2212
 
@@ -2181,14 +2218,21 @@ await client.evaluationSet.list({
2181
2218
  <dl>
2182
2219
  <dd>
2183
2220
 
2184
- Evaluation sets are collections of files and expected outputs that are used to evaluate the performance of a given processor in Extend. This endpoint will create a new evaluation set in Extend, which items can be added to using the [Create Evaluation Set Item](https://docs.extend.ai/2025-04-21/developers/api-reference/evaluation-set-endpoints/create-evaluation-set-item) endpoint.
2221
+ Run processors (extraction, classification, splitting, etc.) on a given document.
2185
2222
 
2186
- 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.
2223
+ **Synchronous vs Asynchronous Processing:**
2187
2224
 
2188
- </dd>
2189
- </dl>
2190
- </dd>
2191
- </dl>
2225
+ - **Asynchronous (default)**: Returns immediately with `PROCESSING` status. Use webhooks or polling to get results.
2226
+ - **Synchronous**: Set `sync: true` to wait for completion and get final results in the response (5-minute timeout).
2227
+
2228
+ **For asynchronous processing:**
2229
+
2230
+ - You can [configure webhooks](https://docs.extend.ai/product/webhooks/configuration) to receive notifications when a processor run is complete or failed.
2231
+ - 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.
2232
+ </dd>
2233
+ </dl>
2234
+ </dd>
2235
+ </dl>
2192
2236
 
2193
2237
  #### 🔌 Usage
2194
2238
 
@@ -2199,9 +2243,7 @@ Note: it is not necessary to create an evaluation set via API. You can also crea
2199
2243
  <dd>
2200
2244
 
2201
2245
  ```typescript
2202
- await client.evaluationSet.create({
2203
- name: "My Evaluation Set",
2204
- description: "My Evaluation Set Description",
2246
+ await client.processorRun.create({
2205
2247
  processorId: "processor_id_here",
2206
2248
  });
2207
2249
  ```
@@ -2219,7 +2261,7 @@ await client.evaluationSet.create({
2219
2261
  <dl>
2220
2262
  <dd>
2221
2263
 
2222
- **request:** `Extend.EvaluationSetCreateRequest`
2264
+ **request:** `Extend.ProcessorRunCreateRequest`
2223
2265
 
2224
2266
  </dd>
2225
2267
  </dl>
@@ -2227,7 +2269,7 @@ await client.evaluationSet.create({
2227
2269
  <dl>
2228
2270
  <dd>
2229
2271
 
2230
- **requestOptions:** `EvaluationSet.RequestOptions`
2272
+ **requestOptions:** `ProcessorRun.RequestOptions`
2231
2273
 
2232
2274
  </dd>
2233
2275
  </dl>
@@ -2238,7 +2280,7 @@ await client.evaluationSet.create({
2238
2280
  </dl>
2239
2281
  </details>
2240
2282
 
2241
- <details><summary><code>client.evaluationSet.<a href="/src/api/resources/evaluationSet/client/Client.ts">get</a>(id) -> Extend.EvaluationSetGetResponse</code></summary>
2283
+ <details><summary><code>client.processorRun.<a href="/src/api/resources/processorRun/client/Client.ts">get</a>(id) -> Extend.ProcessorRunGetResponse</code></summary>
2242
2284
  <dl>
2243
2285
  <dd>
2244
2286
 
@@ -2250,7 +2292,9 @@ await client.evaluationSet.create({
2250
2292
  <dl>
2251
2293
  <dd>
2252
2294
 
2253
- Retrieve a specific evaluation set by ID. This returns an evaluation set object, but does not include the items in the evaluation set. You can use the [List Evaluation Set Items](https://docs.extend.ai/2025-04-21/developers/api-reference/evaluation-set-endpoints/list-evaluation-set-items) endpoint to get the items in an evaluation set.
2295
+ Retrieve details about a specific processor run, including its status, outputs, and any edits made during review.
2296
+
2297
+ 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.
2254
2298
 
2255
2299
  </dd>
2256
2300
  </dl>
@@ -2266,7 +2310,7 @@ Retrieve a specific evaluation set by ID. This returns an evaluation set object,
2266
2310
  <dd>
2267
2311
 
2268
2312
  ```typescript
2269
- await client.evaluationSet.get("evaluation_set_id_here");
2313
+ await client.processorRun.get("processor_run_id_here");
2270
2314
  ```
2271
2315
 
2272
2316
  </dd>
@@ -2284,9 +2328,9 @@ await client.evaluationSet.get("evaluation_set_id_here");
2284
2328
 
2285
2329
  **id:** `string`
2286
2330
 
2287
- The ID of the evaluation set to retrieve.
2331
+ The unique identifier for this processor run.
2288
2332
 
2289
- Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
2333
+ Example: `"dpr_Xj8mK2pL9nR4vT7qY5wZ"`
2290
2334
 
2291
2335
  </dd>
2292
2336
  </dl>
@@ -2294,7 +2338,7 @@ Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
2294
2338
  <dl>
2295
2339
  <dd>
2296
2340
 
2297
- **requestOptions:** `EvaluationSet.RequestOptions`
2341
+ **requestOptions:** `ProcessorRun.RequestOptions`
2298
2342
 
2299
2343
  </dd>
2300
2344
  </dl>
@@ -2305,9 +2349,7 @@ Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
2305
2349
  </dl>
2306
2350
  </details>
2307
2351
 
2308
- ## EvaluationSetItem
2309
-
2310
- <details><summary><code>client.evaluationSetItem.<a href="/src/api/resources/evaluationSetItem/client/Client.ts">list</a>(id, { ...params }) -> Extend.EvaluationSetItemListResponse</code></summary>
2352
+ <details><summary><code>client.processorRun.<a href="/src/api/resources/processorRun/client/Client.ts">delete</a>(id) -> Extend.ProcessorRunDeleteResponse</code></summary>
2311
2353
  <dl>
2312
2354
  <dd>
2313
2355
 
@@ -2319,9 +2361,9 @@ Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
2319
2361
  <dl>
2320
2362
  <dd>
2321
2363
 
2322
- List all items in a specific evaluation set. Evaluation set items are the individual files and expected outputs that are used to evaluate the performance of a given processor in Extend.
2364
+ Delete a processor run and all associated data from Extend. This operation is permanent and cannot be undone.
2323
2365
 
2324
- This endpoint returns a paginated response. You can use the `nextPageToken` to fetch subsequent results.
2366
+ This endpoint can be used if you'd like to manage data retention on your own rather than automated data retention policies. Or make one-off deletions for your downstream customers.
2325
2367
 
2326
2368
  </dd>
2327
2369
  </dl>
@@ -2337,12 +2379,7 @@ This endpoint returns a paginated response. You can use the `nextPageToken` to f
2337
2379
  <dd>
2338
2380
 
2339
2381
  ```typescript
2340
- await client.evaluationSetItem.list("evaluation_set_id_here", {
2341
- sortBy: "updatedAt",
2342
- sortDir: "asc",
2343
- nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ=",
2344
- maxPageSize: 1,
2345
- });
2382
+ await client.processorRun.delete("processor_run_id_here");
2346
2383
  ```
2347
2384
 
2348
2385
  </dd>
@@ -2360,17 +2397,9 @@ await client.evaluationSetItem.list("evaluation_set_id_here", {
2360
2397
 
2361
2398
  **id:** `string`
2362
2399
 
2363
- The ID of the evaluation set to retrieve items for.
2364
-
2365
- Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
2366
-
2367
- </dd>
2368
- </dl>
2369
-
2370
- <dl>
2371
- <dd>
2400
+ The ID of the processor run to delete.
2372
2401
 
2373
- **request:** `Extend.EvaluationSetItemListRequest`
2402
+ Example: `"dpr_Xj8mK2pL9nR4vT7qY5wZ"`
2374
2403
 
2375
2404
  </dd>
2376
2405
  </dl>
@@ -2378,7 +2407,7 @@ Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
2378
2407
  <dl>
2379
2408
  <dd>
2380
2409
 
2381
- **requestOptions:** `EvaluationSetItem.RequestOptions`
2410
+ **requestOptions:** `ProcessorRun.RequestOptions`
2382
2411
 
2383
2412
  </dd>
2384
2413
  </dl>
@@ -2389,7 +2418,7 @@ Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
2389
2418
  </dl>
2390
2419
  </details>
2391
2420
 
2392
- <details><summary><code>client.evaluationSetItem.<a href="/src/api/resources/evaluationSetItem/client/Client.ts">create</a>({ ...params }) -> Extend.EvaluationSetItemCreateResponse</code></summary>
2421
+ <details><summary><code>client.processorRun.<a href="/src/api/resources/processorRun/client/Client.ts">cancel</a>(id) -> Extend.ProcessorRunCancelResponse</code></summary>
2393
2422
  <dl>
2394
2423
  <dd>
2395
2424
 
@@ -2401,25 +2430,14 @@ Example: `"ev_2LcgeY_mp2T5yPaEuq5Lw"`
2401
2430
  <dl>
2402
2431
  <dd>
2403
2432
 
2404
- Evaluation set items are the individual files and expected outputs that are used to evaluate the performance of a given processor in Extend. This endpoint will create a new evaluation set item in Extend, which will be used during an evaluation run.
2433
+ Cancel a running processor run by its ID. This endpoint allows you to stop a processor run that is currently in progress.
2405
2434
 
2406
- Best Practices for Outputs in Evaluation Sets:
2435
+ Note: Only processor runs with a status of `"PROCESSING"` can be cancelled. Processor runs that have already completed, failed, or been cancelled cannot be cancelled again.
2407
2436
 
2408
- - **Configure First, Output Later**
2409
- - Always create and finalize your processor configuration before creating evaluation sets
2410
- - Field IDs in outputs must match those defined in your processor configuration
2411
- - **Type Consistency**
2412
- - Ensure output types exactly match your processor configuration
2413
- - For example, if a field is configured as "currency", don't submit a simple number value
2414
- - **Field IDs**
2415
- - Use the exact field IDs from your processor configuration
2416
- - Create your own semantic IDs instead in the configs for each field/type instead of using the generated ones
2417
- - **Value**
2418
- - Remember that all results are inside the value key of a result object, except the values within nested structures.
2419
- </dd>
2420
- </dl>
2421
- </dd>
2422
- </dl>
2437
+ </dd>
2438
+ </dl>
2439
+ </dd>
2440
+ </dl>
2423
2441
 
2424
2442
  #### 🔌 Usage
2425
2443
 
@@ -2430,15 +2448,7 @@ Best Practices for Outputs in Evaluation Sets:
2430
2448
  <dd>
2431
2449
 
2432
2450
  ```typescript
2433
- await client.evaluationSetItem.create({
2434
- evaluationSetId: "evaluation_set_id_here",
2435
- fileId: "file_id_here",
2436
- expectedOutput: {
2437
- value: {
2438
- key: "value",
2439
- },
2440
- },
2441
- });
2451
+ await client.processorRun.cancel("processor_run_id_here");
2442
2452
  ```
2443
2453
 
2444
2454
  </dd>
@@ -2454,7 +2464,11 @@ await client.evaluationSetItem.create({
2454
2464
  <dl>
2455
2465
  <dd>
2456
2466
 
2457
- **request:** `Extend.EvaluationSetItemCreateRequest`
2467
+ **id:** `string`
2468
+
2469
+ The unique identifier for the processor run to cancel.
2470
+
2471
+ Example: `"dpr_Xj8mK2pL9nR4vT7qY5wZ"`
2458
2472
 
2459
2473
  </dd>
2460
2474
  </dl>
@@ -2462,7 +2476,7 @@ await client.evaluationSetItem.create({
2462
2476
  <dl>
2463
2477
  <dd>
2464
2478
 
2465
- **requestOptions:** `EvaluationSetItem.RequestOptions`
2479
+ **requestOptions:** `ProcessorRun.RequestOptions`
2466
2480
 
2467
2481
  </dd>
2468
2482
  </dl>
@@ -2473,7 +2487,9 @@ await client.evaluationSetItem.create({
2473
2487
  </dl>
2474
2488
  </details>
2475
2489
 
2476
- <details><summary><code>client.evaluationSetItem.<a href="/src/api/resources/evaluationSetItem/client/Client.ts">update</a>(id, { ...params }) -> Extend.EvaluationSetItemUpdateResponse</code></summary>
2490
+ ## Processor
2491
+
2492
+ <details><summary><code>client.processor.<a href="/src/api/resources/processor/client/Client.ts">list</a>({ ...params }) -> Extend.ListProcessorsResponse</code></summary>
2477
2493
  <dl>
2478
2494
  <dd>
2479
2495
 
@@ -2485,7 +2501,7 @@ await client.evaluationSetItem.create({
2485
2501
  <dl>
2486
2502
  <dd>
2487
2503
 
2488
- If you need to change the expected output for a given evaluation set item, you can use this endpoint to update the item. This can be useful if you need to correct an error in the expected output or if the output of the processor has changed.
2504
+ List all processors in your organization
2489
2505
 
2490
2506
  </dd>
2491
2507
  </dl>
@@ -2501,12 +2517,12 @@ If you need to change the expected output for a given evaluation set item, you c
2501
2517
  <dd>
2502
2518
 
2503
2519
  ```typescript
2504
- await client.evaluationSetItem.update("evaluation_set_item_id_here", {
2505
- expectedOutput: {
2506
- value: {
2507
- key: "value",
2508
- },
2509
- },
2520
+ await client.processor.list({
2521
+ type: "EXTRACT",
2522
+ nextPageToken: "nextPageToken",
2523
+ maxPageSize: 1,
2524
+ sortBy: "createdAt",
2525
+ sortDir: "asc",
2510
2526
  });
2511
2527
  ```
2512
2528
 
@@ -2523,19 +2539,7 @@ await client.evaluationSetItem.update("evaluation_set_item_id_here", {
2523
2539
  <dl>
2524
2540
  <dd>
2525
2541
 
2526
- **id:** `string`
2527
-
2528
- The ID of the evaluation set item to update.
2529
-
2530
- Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
2531
-
2532
- </dd>
2533
- </dl>
2534
-
2535
- <dl>
2536
- <dd>
2537
-
2538
- **request:** `Extend.EvaluationSetItemUpdateRequest`
2542
+ **request:** `Extend.ProcessorListRequest`
2539
2543
 
2540
2544
  </dd>
2541
2545
  </dl>
@@ -2543,7 +2547,7 @@ Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
2543
2547
  <dl>
2544
2548
  <dd>
2545
2549
 
2546
- **requestOptions:** `EvaluationSetItem.RequestOptions`
2550
+ **requestOptions:** `Processor.RequestOptions`
2547
2551
 
2548
2552
  </dd>
2549
2553
  </dl>
@@ -2554,7 +2558,7 @@ Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
2554
2558
  </dl>
2555
2559
  </details>
2556
2560
 
2557
- <details><summary><code>client.evaluationSetItem.<a href="/src/api/resources/evaluationSetItem/client/Client.ts">delete</a>(id) -> Extend.EvaluationSetItemDeleteResponse</code></summary>
2561
+ <details><summary><code>client.processor.<a href="/src/api/resources/processor/client/Client.ts">create</a>({ ...params }) -> Extend.ProcessorCreateResponse</code></summary>
2558
2562
  <dl>
2559
2563
  <dd>
2560
2564
 
@@ -2566,9 +2570,7 @@ Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
2566
2570
  <dl>
2567
2571
  <dd>
2568
2572
 
2569
- Delete an evaluation set item from an evaluation set. This operation is permanent and cannot be undone.
2570
-
2571
- This endpoint can be used to remove individual items from an evaluation set when they are no longer needed or if they were added in error.
2573
+ Create a new processor in Extend, optionally cloning from an existing processor
2572
2574
 
2573
2575
  </dd>
2574
2576
  </dl>
@@ -2584,7 +2586,10 @@ This endpoint can be used to remove individual items from an evaluation set when
2584
2586
  <dd>
2585
2587
 
2586
2588
  ```typescript
2587
- await client.evaluationSetItem.delete("evaluation_set_item_id_here");
2589
+ await client.processor.create({
2590
+ name: "My Processor Name",
2591
+ type: "EXTRACT",
2592
+ });
2588
2593
  ```
2589
2594
 
2590
2595
  </dd>
@@ -2600,11 +2605,7 @@ await client.evaluationSetItem.delete("evaluation_set_item_id_here");
2600
2605
  <dl>
2601
2606
  <dd>
2602
2607
 
2603
- **id:** `string`
2604
-
2605
- The ID of the evaluation set item to delete.
2606
-
2607
- Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
2608
+ **request:** `Extend.ProcessorCreateRequest`
2608
2609
 
2609
2610
  </dd>
2610
2611
  </dl>
@@ -2612,7 +2613,7 @@ Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
2612
2613
  <dl>
2613
2614
  <dd>
2614
2615
 
2615
- **requestOptions:** `EvaluationSetItem.RequestOptions`
2616
+ **requestOptions:** `Processor.RequestOptions`
2616
2617
 
2617
2618
  </dd>
2618
2619
  </dl>
@@ -2623,7 +2624,7 @@ Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
2623
2624
  </dl>
2624
2625
  </details>
2625
2626
 
2626
- <details><summary><code>client.evaluationSetItem.<a href="/src/api/resources/evaluationSetItem/client/Client.ts">createBatch</a>({ ...params }) -> Extend.EvaluationSetItemCreateBatchResponse</code></summary>
2627
+ <details><summary><code>client.processor.<a href="/src/api/resources/processor/client/Client.ts">update</a>(id, { ...params }) -> Extend.ProcessorUpdateResponse</code></summary>
2627
2628
  <dl>
2628
2629
  <dd>
2629
2630
 
@@ -2635,9 +2636,7 @@ Example: `"evi_kR9mNP12Qw4yTv8BdR3H"`
2635
2636
  <dl>
2636
2637
  <dd>
2637
2638
 
2638
- If you have a large number of files that you need to add to an evaluation set, you can use this endpoint to create multiple evaluation set items at once. This can be useful if you have a large dataset that you need to evaluate the performance of a processor against.
2639
-
2640
- Note: you still need to create each File first using the file API.
2639
+ Update an existing processor in Extend
2641
2640
 
2642
2641
  </dd>
2643
2642
  </dl>
@@ -2653,19 +2652,7 @@ Note: you still need to create each File first using the file API.
2653
2652
  <dd>
2654
2653
 
2655
2654
  ```typescript
2656
- await client.evaluationSetItem.createBatch({
2657
- evaluationSetId: "evaluation_set_id_here",
2658
- items: [
2659
- {
2660
- fileId: "file_id_here",
2661
- expectedOutput: {
2662
- value: {
2663
- key: "value",
2664
- },
2665
- },
2666
- },
2667
- ],
2668
- });
2655
+ await client.processor.update("processor_id_here");
2669
2656
  ```
2670
2657
 
2671
2658
  </dd>
@@ -2681,7 +2668,11 @@ await client.evaluationSetItem.createBatch({
2681
2668
  <dl>
2682
2669
  <dd>
2683
2670
 
2684
- **request:** `Extend.EvaluationSetItemCreateBatchRequest`
2671
+ **id:** `string`
2672
+
2673
+ The ID of the processor to update.
2674
+
2675
+ Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
2685
2676
 
2686
2677
  </dd>
2687
2678
  </dl>
@@ -2689,7 +2680,15 @@ await client.evaluationSetItem.createBatch({
2689
2680
  <dl>
2690
2681
  <dd>
2691
2682
 
2692
- **requestOptions:** `EvaluationSetItem.RequestOptions`
2683
+ **request:** `Extend.ProcessorUpdateRequest`
2684
+
2685
+ </dd>
2686
+ </dl>
2687
+
2688
+ <dl>
2689
+ <dd>
2690
+
2691
+ **requestOptions:** `Processor.RequestOptions`
2693
2692
 
2694
2693
  </dd>
2695
2694
  </dl>
@@ -2700,9 +2699,9 @@ await client.evaluationSetItem.createBatch({
2700
2699
  </dl>
2701
2700
  </details>
2702
2701
 
2703
- ## WorkflowRunOutput
2702
+ ## ProcessorVersion
2704
2703
 
2705
- <details><summary><code>client.workflowRunOutput.<a href="/src/api/resources/workflowRunOutput/client/Client.ts">update</a>(workflowRunId, outputId, { ...params }) -> Extend.WorkflowRunOutputUpdateResponse</code></summary>
2704
+ <details><summary><code>client.processorVersion.<a href="/src/api/resources/processorVersion/client/Client.ts">list</a>(id) -> Extend.ProcessorVersionListResponse</code></summary>
2706
2705
  <dl>
2707
2706
  <dd>
2708
2707
 
@@ -2714,11 +2713,10 @@ await client.evaluationSetItem.createBatch({
2714
2713
  <dl>
2715
2714
  <dd>
2716
2715
 
2717
- Use this endpoint to submit corrected outputs for a WorkflowRun for future processor evaluation and tuning in Extend.
2718
-
2719
- If you are using our Human-in-the-loop workflow review, then we already will be collecting your operator submitted corrections. However, if you are receiving data via the API without human review, there could be incorrect outputs that you would like to correct for future usage in evaluation and tuning within the Extend platform. This endpoint allows you to submit corrected outputs for a WorkflowRun, by providing the correct output for a given output ID.
2716
+ This endpoint allows you to fetch all versions of a given processor, including the current `draft` version.
2720
2717
 
2721
- The output ID, would be found in a given entry within the outputs arrays of a Workflow Run payload. The ID would look something like `dpr_gwkZZNRrPgkjcq0y-***`.
2718
+ Versions are typically returned in descending order of creation (newest first), but this should be confirmed in the actual implementation.
2719
+ The `draft` version is the latest unpublished version of the processor, which can be published to create a new version. It might not have any changes from the last published version.
2722
2720
 
2723
2721
  </dd>
2724
2722
  </dl>
@@ -2734,13 +2732,7 @@ The output ID, would be found in a given entry within the outputs arrays of a Wo
2734
2732
  <dd>
2735
2733
 
2736
2734
  ```typescript
2737
- await client.workflowRunOutput.update("workflow_run_id_here", "output_id_here", {
2738
- reviewedOutput: {
2739
- value: {
2740
- key: "value",
2741
- },
2742
- },
2743
- });
2735
+ await client.processorVersion.list("processor_id_here");
2744
2736
  ```
2745
2737
 
2746
2738
  </dd>
@@ -2756,23 +2748,11 @@ await client.workflowRunOutput.update("workflow_run_id_here", "output_id_here",
2756
2748
  <dl>
2757
2749
  <dd>
2758
2750
 
2759
- **workflowRunId:** `string`
2760
-
2761
- </dd>
2762
- </dl>
2763
-
2764
- <dl>
2765
- <dd>
2766
-
2767
- **outputId:** `string`
2768
-
2769
- </dd>
2770
- </dl>
2751
+ **id:** `string`
2771
2752
 
2772
- <dl>
2773
- <dd>
2753
+ The ID of the processor to retrieve versions for.
2774
2754
 
2775
- **request:** `Extend.WorkflowRunOutputUpdateRequest`
2755
+ Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
2776
2756
 
2777
2757
  </dd>
2778
2758
  </dl>
@@ -2780,7 +2760,7 @@ await client.workflowRunOutput.update("workflow_run_id_here", "output_id_here",
2780
2760
  <dl>
2781
2761
  <dd>
2782
2762
 
2783
- **requestOptions:** `WorkflowRunOutput.RequestOptions`
2763
+ **requestOptions:** `ProcessorVersion.RequestOptions`
2784
2764
 
2785
2765
  </dd>
2786
2766
  </dl>
@@ -2791,9 +2771,7 @@ await client.workflowRunOutput.update("workflow_run_id_here", "output_id_here",
2791
2771
  </dl>
2792
2772
  </details>
2793
2773
 
2794
- ## BatchProcessorRun
2795
-
2796
- <details><summary><code>client.batchProcessorRun.<a href="/src/api/resources/batchProcessorRun/client/Client.ts">get</a>(id) -> Extend.BatchProcessorRunGetResponse</code></summary>
2774
+ <details><summary><code>client.processorVersion.<a href="/src/api/resources/processorVersion/client/Client.ts">create</a>(id, { ...params }) -> Extend.ProcessorVersionCreateResponse</code></summary>
2797
2775
  <dl>
2798
2776
  <dd>
2799
2777
 
@@ -2805,7 +2783,9 @@ await client.workflowRunOutput.update("workflow_run_id_here", "output_id_here",
2805
2783
  <dl>
2806
2784
  <dd>
2807
2785
 
2808
- Retrieve details about a batch processor run, including evaluation runs
2786
+ This endpoint allows you to publish a new version of an existing processor. Publishing a new version creates a snapshot of the processor's current configuration and makes it available for use in workflows.
2787
+
2788
+ Publishing a new version does not automatically update existing workflows using this processor. You may need to manually update workflows to use the new version if desired.
2809
2789
 
2810
2790
  </dd>
2811
2791
  </dl>
@@ -2821,7 +2801,9 @@ Retrieve details about a batch processor run, including evaluation runs
2821
2801
  <dd>
2822
2802
 
2823
2803
  ```typescript
2824
- await client.batchProcessorRun.get("batch_processor_run_id_here");
2804
+ await client.processorVersion.create("processor_id_here", {
2805
+ releaseType: "major",
2806
+ });
2825
2807
  ```
2826
2808
 
2827
2809
  </dd>
@@ -2839,9 +2821,9 @@ await client.batchProcessorRun.get("batch_processor_run_id_here");
2839
2821
 
2840
2822
  **id:** `string`
2841
2823
 
2842
- The unique identifier of the batch processor run to retrieve. The ID will always start with "bpr\_".
2824
+ The ID of the processor to publish a new version for.
2843
2825
 
2844
- Example: `"bpr_Xj8mK2pL9nR4vT7qY5wZ"`
2826
+ Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
2845
2827
 
2846
2828
  </dd>
2847
2829
  </dl>
@@ -2849,7 +2831,15 @@ Example: `"bpr_Xj8mK2pL9nR4vT7qY5wZ"`
2849
2831
  <dl>
2850
2832
  <dd>
2851
2833
 
2852
- **requestOptions:** `BatchProcessorRun.RequestOptions`
2834
+ **request:** `Extend.ProcessorVersionCreateRequest`
2835
+
2836
+ </dd>
2837
+ </dl>
2838
+
2839
+ <dl>
2840
+ <dd>
2841
+
2842
+ **requestOptions:** `ProcessorVersion.RequestOptions`
2853
2843
 
2854
2844
  </dd>
2855
2845
  </dl>
@@ -2860,9 +2850,7 @@ Example: `"bpr_Xj8mK2pL9nR4vT7qY5wZ"`
2860
2850
  </dl>
2861
2851
  </details>
2862
2852
 
2863
- ## Workflow
2864
-
2865
- <details><summary><code>client.workflow.<a href="/src/api/resources/workflow/client/Client.ts">create</a>({ ...params }) -> Extend.WorkflowCreateResponse</code></summary>
2853
+ <details><summary><code>client.processorVersion.<a href="/src/api/resources/processorVersion/client/Client.ts">get</a>(processorId, processorVersionId) -> Extend.ProcessorVersionGetResponse</code></summary>
2866
2854
  <dl>
2867
2855
  <dd>
2868
2856
 
@@ -2874,9 +2862,7 @@ Example: `"bpr_Xj8mK2pL9nR4vT7qY5wZ"`
2874
2862
  <dl>
2875
2863
  <dd>
2876
2864
 
2877
- Create a new workflow in Extend. Workflows are sequences of steps that process files and data in a specific order to achieve a desired outcome.
2878
-
2879
- This endpoint will create a new workflow in Extend, which can then be configured and deployed. Typically, workflows are created from our UI, however this endpoint can be used to create workflows programmatically. Configuration of the flow still needs to be done in the dashboard.
2865
+ Retrieve a specific version of a processor in Extend
2880
2866
 
2881
2867
  </dd>
2882
2868
  </dl>
@@ -2892,9 +2878,7 @@ This endpoint will create a new workflow in Extend, which can then be configured
2892
2878
  <dd>
2893
2879
 
2894
2880
  ```typescript
2895
- await client.workflow.create({
2896
- name: "Invoice Processing",
2897
- });
2881
+ await client.processorVersion.get("processor_id_here", "processor_version_id_here");
2898
2882
  ```
2899
2883
 
2900
2884
  </dd>
@@ -2910,7 +2894,11 @@ await client.workflow.create({
2910
2894
  <dl>
2911
2895
  <dd>
2912
2896
 
2913
- **request:** `Extend.WorkflowCreateRequest`
2897
+ **processorId:** `string`
2898
+
2899
+ The ID of the processor.
2900
+
2901
+ Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
2914
2902
 
2915
2903
  </dd>
2916
2904
  </dl>
@@ -2918,7 +2906,19 @@ await client.workflow.create({
2918
2906
  <dl>
2919
2907
  <dd>
2920
2908
 
2921
- **requestOptions:** `Workflow.RequestOptions`
2909
+ **processorVersionId:** `string`
2910
+
2911
+ The ID of the specific processor version to retrieve.
2912
+
2913
+ Example: `"dpv_QYk6jgHA_8CsO8rVWhyNC"`
2914
+
2915
+ </dd>
2916
+ </dl>
2917
+
2918
+ <dl>
2919
+ <dd>
2920
+
2921
+ **requestOptions:** `ProcessorVersion.RequestOptions`
2922
2922
 
2923
2923
  </dd>
2924
2924
  </dl>