Get Workflow Run

GET

https://api.extend.ai/workflow_runs/:workflowRunId

GET

/workflow_runs/:workflowRunId

1 curl https://api.extend.ai/workflow_runs/workflow_run_id_here \
2      -H "x-extend-api-version: " \
3      -H "Authorization: Bearer <token>"

Try it

200Retrieved

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               "verticalGroupingThreshold": 1
134             }
135           }
136         },
137         "files": [
138           {
139             "object": "file",
140             "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
141             "name": "Invoices.pdf",
142             "metadata": {
143               "pageCount": 30,
144               "parentSplit": {
145                 "id": "string",
146                 "type": "Invoice",
147                 "identifier": "other_2_9",
148                 "startPage": 1,
149                 "endPage": 10
150               }
151             },
152             "createdAt": "2024-03-21T15:30:00Z",
153             "updatedAt": "2024-03-21T16:45:00Z",
154             "type": "PDF",
155             "presignedUrl": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
156             "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
157             "contents": {
158               "rawText": "string",
159               "markdown": "string",
160               "pages": [
161                 {
162                   "pageNumber": 1,
163                   "pageHeight": 10,
164                   "pageWidth": 10,
165                   "rawText": "This is the raw text of the page.",
166                   "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",
167                   "html": "<div>This is the html of the page.</div>"
168                 }
169               ],
170               "sheets": [
171                 {
172                   "sheetName": "Sheet1",
173                   "rawText": "This is the raw text of the sheet."
174                 }
175               ]
176             },
177             "usage": {
178               "credits": 10
179             }
180           }
181         ],
182         "mergedProcessors": [
183           {
184             "processorId": "dp_Xj8mK2pL9nR4vT7qY5wZ",
185             "processorVersionId": "dpv_Xj8mK2pL9nR4vT7qY5wZ",
186             "processorName": "Invoice Line Items Processor"
187           }
188         ],
189         "url": "https://dashboard.extend.ai/runs/dpr_Xj8mK2pL9nR4vT7qY5wZ",
190         "failureReason": "string",
191         "failureMessage": "string",
192         "metadata": {},
193         "initialOutput": {},
194         "reviewedOutput": {},
195         "usage": {
196           "credits": 3.5
197         }
198       }
199     ],
200     "stepRuns": [
201       {
202         "object": "workflow_step_run",
203         "id": "workflow_step_run_xK9mLPqRtN3vS8wF5hB2cQ",
204         "status": "PENDING",
205         "step": {
206           "object": "workflow_step",
207           "id": "step_xK9mLPqRtN3vS8wF5hB2cQ",
208           "name": "Validate Invoice Total",
209           "type": "EXTERNAL_DATA_VALIDATION"
210         },
211         "output": {
212           "rules": [
213             {
214               "name": "string",
215               "valid": true,
216               "validArray": [
217                 "string"
218               ],
219               "failureReason": "RULE_FAILED",
220               "error": "string"
221             }
222           ]
223         }
224       }
225     ],
226     "workflow": {
227       "object": "workflow",
228       "id": "workflow_BMlfq_yWM3sT-ZzvCnA3f",
229       "version": "draft",
230       "name": "Invoice Processing"
231     },
232     "batchId": "batch_7Ws31-F5",
233     "failureReason": "string",
234     "failureMessage": "string",
235     "reviewedBy": "jane.doe@example.com",
236     "rejectionNote": "string",
237     "reviewedAt": "2024-03-21T16:45:00Z",
238     "startTime": "2024-03-21T15:30:00Z",
239     "endTime": "2024-03-21T15:35:00Z",
240     "usage": {
241       "credits": 25
242     }
243   }
244 }

Once a workflow has been run, you can check the status and output of a specific WorkflowRun.

Authentication

AuthorizationBearer

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

Path Parameters

workflowRunIdstringRequired

The ID of the WorkflowRun that was outputted after a Workflow was run through the API.

Example: "workflow_run_8k9m-xyzAB_Pqrst-Nvw4"

Response

Successfully retrieved workflow run

successboolean

workflowRunobject

Get Workflow Run

Authentication

Path Parameters

Headers

Response

Errors