GuidesAPI ReferenceProcessor Changelog
GuidesAPI ReferenceProcessor Changelog
    • Getting Started
    • API Versioning
    • SDKs
  • Processor Endpoints
    • POSTRun Processor
    • GETList Processor Runs
    • GETGet Processor Run
    • POSTCancel Processor Run
    • DELDelete Processor Run
    • GETGet Batch Processor Run
    • POSTCreate Processor
    • POSTUpdate Processor
    • POSTPublish Processor Version
    • GETGet Processor Version
    • GETList Processor Versions
  • Workflow Endpoints
    • POSTRun Workflow
    • GETGet Workflow Run
    • GETList Workflow Runs
    • POSTUpdate Workflow Run
    • POSTCancel Workflow Run
    • DELDelete Workflow Run
    • POSTCreate Workflow
    • POSTBatch Run Workflow
    • POSTCorrect Workflow Run Outputs
  • Parse Endpoints
    • POSTParse File
    • POSTParse File Async
    • GETGet Parser Run
    • DELDelete Parser Run
  • File Endpoints
    • POSTUpload File
    • GETGet File
    • DELDelete File
    • GETList Files
    • POSTCreate File
  • Evaluation Set Endpoints
    • GETGet Evaluation Set
    • GETList Evaluation Sets
    • POSTCreate Evaluation Set
    • GETList Evaluation Set Items
    • POSTCreate Evaluation Set Item
    • POSTUpdate Evaluation Set Item
    • POSTBulk Create Evaluation Set Items
LogoLogo
Workflow Endpoints

Deprecated
POST
https://api.extend.ai/workflow_runs/:workflowRunId/outputs/:outputId
POST
/workflow_runs/:workflowRunId/outputs/:outputId
1curl -X POST https://api.extend.ai/workflow_runs/workflow_run_id_here/outputs/output_id_here \
2 -H "x-extend-api-version: " \
3 -H "Authorization: Bearer <token>" \
4 -H "Content-Type: application/json" \
5 -d '{
6 "reviewedOutput": {
7 "value": {}
8 }
9}'
Try it
200Successful
1{
2 "success": true,
3 "workflowRun": {
4 "object": "workflow_run",
5 "id": "workflow_run_xKm9pNv3qWsY_jL2tR5Dh",
6 "name": "myFirstFile.pdf",
7 "url": "https://dashboard.extend.ai/workflows/workflow_Bk9mNp2qWs5_xL8vR4tYh?workflowRunId=workflow_run_Zj3nMx7ZPd9f4c2WQ_kAg",
8 "status": "PENDING",
9 "metadata": {},
10 "files": [
11 {
12 "object": "file",
13 "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
14 "name": "Invoices.pdf",
15 "metadata": {
16 "pageCount": 30,
17 "parentSplit": {
18 "id": "string",
19 "type": "Invoice",
20 "identifier": "other_2_9",
21 "startPage": 1,
22 "endPage": 10
23 }
24 },
25 "createdAt": "2024-03-21T15:30:00Z",
26 "updatedAt": "2024-03-21T16:45:00Z",
27 "type": "PDF",
28 "presignedUrl": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
29 "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
30 "contents": {
31 "rawText": "string",
32 "markdown": "string",
33 "pages": [
34 {
35 "pageNumber": 1,
36 "pageHeight": 10,
37 "pageWidth": 10,
38 "rawText": "This is the raw text of the page.",
39 "markdown": "# Heading\n\nThis is a paragraph with **bold** and *italic* text.\n\n- List item 1\n- List item 2\n\n> This is a blockquote",
40 "html": "<div>This is the html of the page.</div>"
41 }
42 ],
43 "sheets": [
44 {
45 "sheetName": "Sheet1",
46 "rawText": "This is the raw text of the sheet."
47 }
48 ]
49 },
50 "usage": {
51 "credits": 10
52 }
53 }
54 ],
55 "initialRunAt": "2025-04-28T17:01:39.285Z",
56 "reviewed": true,
57 "outputs": [
58 {
59 "object": "document_processor_run",
60 "id": "dpr_Xj8mK2pL9nR4vT7qY5wZ",
61 "processorId": "dp_Xj8mK2pL9nR4vT7qY5wZ",
62 "processorVersionId": "dpv_Xj8mK2pL9nR4vT7qY5wZ",
63 "processorName": "Invoice Processor",
64 "status": "PENDING",
65 "output": {},
66 "reviewed": false,
67 "edited": false,
68 "edits": {},
69 "type": "CLASSIFY",
70 "config": {
71 "type": "CLASSIFY",
72 "baseProcessor": "classification_performance",
73 "baseVersion": "3.2.0",
74 "classifications": [
75 {
76 "id": "my_unique_id",
77 "type": "invoice",
78 "description": "An invoice is a document that lists the items purchased and the total amount due."
79 }
80 ],
81 "classificationRules": "Rememeber, when it comes to differentiating between invoices and purchase orders, the most important thing to look for is the date of the document.",
82 "advancedOptions": {
83 "context": "default",
84 "advancedMultimodalEnabled": false,
85 "fixedPageLimit": 30,
86 "pageRanges": [
87 {
88 "start": 1,
89 "end": 10
90 },
91 {
92 "start": 20,
93 "end": 30
94 }
95 ]
96 },
97 "parser": {
98 "target": "markdown",
99 "chunkingStrategy": {
100 "type": "page",
101 "options": {
102 "minCharacters": 100,
103 "maxCharacters": 1000
104 }
105 },
106 "blockOptions": {
107 "figures": {
108 "enabled": true,
109 "figureImageClippingEnabled": true
110 },
111 "tables": {
112 "enabled": true,
113 "targetFormat": "markdown",
114 "tableHeaderContinuationEnabled": false
115 },
116 "text": {
117 "signatureDetectionEnabled": true
118 }
119 },
120 "advancedOptions": {
121 "pageRotationEnabled": true,
122 "agenticOcrEnabled": false,
123 "pageRanges": [
124 {
125 "start": 1,
126 "end": 10
127 },
128 {
129 "start": 20,
130 "end": 30
131 }
132 ]
133 }
134 }
135 },
136 "files": [
137 {
138 "object": "file",
139 "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
140 "name": "Invoices.pdf",
141 "metadata": {
142 "pageCount": 30,
143 "parentSplit": {
144 "id": "string",
145 "type": "Invoice",
146 "identifier": "other_2_9",
147 "startPage": 1,
148 "endPage": 10
149 }
150 },
151 "createdAt": "2024-03-21T15:30:00Z",
152 "updatedAt": "2024-03-21T16:45:00Z",
153 "type": "PDF",
154 "presignedUrl": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
155 "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
156 "contents": {
157 "rawText": "string",
158 "markdown": "string",
159 "pages": [
160 {
161 "pageNumber": 1,
162 "pageHeight": 10,
163 "pageWidth": 10,
164 "rawText": "This is the raw text of the page.",
165 "markdown": "# Heading\n\nThis is a paragraph with **bold** and *italic* text.\n\n- List item 1\n- List item 2\n\n> This is a blockquote",
166 "html": "<div>This is the html of the page.</div>"
167 }
168 ],
169 "sheets": [
170 {
171 "sheetName": "Sheet1",
172 "rawText": "This is the raw text of the sheet."
173 }
174 ]
175 },
176 "usage": {
177 "credits": 10
178 }
179 }
180 ],
181 "mergedProcessors": [
182 {
183 "processorId": "dp_Xj8mK2pL9nR4vT7qY5wZ",
184 "processorVersionId": "dpv_Xj8mK2pL9nR4vT7qY5wZ",
185 "processorName": "Invoice Line Items Processor"
186 }
187 ],
188 "url": "https://dashboard.extend.ai/runs/dpr_Xj8mK2pL9nR4vT7qY5wZ",
189 "failureReason": "string",
190 "failureMessage": "string",
191 "metadata": {},
192 "initialOutput": {},
193 "reviewedOutput": {},
194 "usage": {
195 "credits": 3.5
196 }
197 }
198 ],
199 "stepRuns": [
200 {
201 "object": "workflow_step_run",
202 "id": "workflow_step_run_xK9mLPqRtN3vS8wF5hB2cQ",
203 "status": "PENDING",
204 "step": {
205 "object": "workflow_step",
206 "id": "step_xK9mLPqRtN3vS8wF5hB2cQ",
207 "name": "Validate Invoice Total",
208 "type": "EXTERNAL_DATA_VALIDATION"
209 },
210 "output": {
211 "rules": [
212 {
213 "name": "string",
214 "valid": true,
215 "validArray": [
216 "string"
217 ],
218 "failureReason": "RULE_FAILED",
219 "error": "string"
220 }
221 ]
222 }
223 }
224 ],
225 "workflow": {
226 "object": "workflow",
227 "id": "workflow_BMlfq_yWM3sT-ZzvCnA3f",
228 "version": "draft",
229 "name": "Invoice Processing"
230 },
231 "batchId": "batch_7Ws31-F5",
232 "failureReason": "string",
233 "failureMessage": "string",
234 "reviewedBy": "jane.doe@example.com",
235 "rejectionNote": "string",
236 "reviewedAt": "2024-03-21T16:45:00Z",
237 "startTime": "2024-03-21T15:30:00Z",
238 "endTime": "2024-03-21T15:35:00Z",
239 "usage": {
240 "credits": 25
241 }
242 }
243}
Was this page helpful?
Previous

Parse File

Next
Built with
Use this endpoint to submit corrected outputs for a WorkflowRun for future processor evaluation and tuning in Extend. 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. 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-***`.
Correct Workflow Run Outputs

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Path parameters

workflowRunIdstringRequired
outputIdstringRequired

Headers

x-extend-api-version"2025-04-21"OptionalDefaults to 2025-04-21
API version to use for the request. If you do not specify a version, you will either receive a `400 Bad Request` or be set to a previous legacy version. See [API Versioning](/developers/api-versioning) for more details.

Request

This endpoint expects an object.
reviewedOutputobject or map from strings to objects or objectRequired
The corrected output of the processor when run against the file. This should conform to the output type schema of the given processor. If this is an extraction result, you can include all fields, or just the ones that were corrected, our system will handle merges/dedupes. However, if you do include a field, we assume the value included in the final reviewed value.

Response

Successfully corrected workflow run output
successboolean
workflowRunobject

Errors

Successfully corrected workflow run output

Bearer authentication of the form Bearer <token>, where token is your auth token.

API version to use for the request. If you do not specify a version, you will either receive a 400 Bad Request or be set to a previous legacy version. See API Versioning for more details.

The corrected output of the processor when run against the file.

This should conform to the output type schema of the given processor.

If this is an extraction result, you can include all fields, or just the ones that were corrected, our system will handle merges/dedupes. However, if you do include a field, we assume the value included in the final reviewed value.

Use this endpoint to submit corrected outputs for a WorkflowRun for future processor evaluation and tuning in Extend.

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.

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-***.