Get Workflow Run

GET

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

GET

/workflow_runs/:workflowRunId

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

Try it

200

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": "foo",
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": "foo",
32           "markdown": "foo",
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       }
51     ],
52     "initialRunAt": "2025-04-28T17:01:39.285Z",
53     "reviewed": true,
54     "outputs": [
55       {
56         "object": "document_processor_run",
57         "id": "dpr_Xj8mK2pL9nR4vT7qY5wZ",
58         "processorId": "dp_Xj8mK2pL9nR4vT7qY5wZ",
59         "processorVersionId": "dpv_Xj8mK2pL9nR4vT7qY5wZ",
60         "processorName": "Invoice Processor",
61         "status": "PROCESSING",
62         "output": {},
63         "reviewed": false,
64         "edited": false,
65         "edits": {},
66         "type": "CLASSIFY",
67         "config": {
68           "type": "CLASSIFY",
69           "baseProcessor": "classifier_performance",
70           "baseVersion": "3.2.0",
71           "classifications": [
72             {
73               "id": "my_unique_id",
74               "type": "invoice",
75               "description": "An invoice is a document that lists the items purchased and the total amount due."
76             }
77           ],
78           "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.",
79           "advancedOptions": {
80             "context": "default",
81             "advancedMultimodalEnabled": false,
82             "fixedPageLimit": 10
83           }
84         },
85         "files": [
86           {
87             "object": "file",
88             "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
89             "name": "Invoices.pdf",
90             "metadata": {
91               "pageCount": 30,
92               "parentSplit": {
93                 "id": "foo",
94                 "type": "Invoice",
95                 "identifier": "other_2_9",
96                 "startPage": 1,
97                 "endPage": 10
98               }
99             },
100             "createdAt": "2024-03-21T15:30:00Z",
101             "updatedAt": "2024-03-21T16:45:00Z",
102             "type": "PDF",
103             "presignedUrl": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
104             "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
105             "contents": {
106               "rawText": "foo",
107               "markdown": "foo",
108               "pages": [
109                 {
110                   "pageNumber": 1,
111                   "pageHeight": 10,
112                   "pageWidth": 10,
113                   "rawText": "This is the raw text of the page.",
114                   "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",
115                   "html": "<div>This is the html of the page.</div>"
116                 }
117               ],
118               "sheets": [
119                 {
120                   "sheetName": "Sheet1",
121                   "rawText": "This is the raw text of the sheet."
122                 }
123               ]
124             }
125           }
126         ],
127         "mergedProcessors": [
128           {
129             "processorId": "dp_Xj8mK2pL9nR4vT7qY5wZ",
130             "processorVersionId": "dpv_Xj8mK2pL9nR4vT7qY5wZ",
131             "processorName": "Invoice Line Items Processor"
132           }
133         ],
134         "url": "https://dashboard.extend.ai/runs/dpr_Xj8mK2pL9nR4vT7qY5wZ",
135         "failureReason": "foo",
136         "failureMessage": "foo",
137         "metadata": {},
138         "initialOutput": {},
139         "reviewedOutput": {}
140       }
141     ],
142     "stepRuns": [
143       {
144         "object": "workflow_step_run",
145         "id": "workflow_step_run_xK9mLPqRtN3vS8wF5hB2cQ",
146         "status": "PENDING",
147         "step": {
148           "object": "workflow_step",
149           "id": "step_xK9mLPqRtN3vS8wF5hB2cQ",
150           "name": "Validate Invoice Total",
151           "type": "EXTERNAL_DATA_VALIDATION"
152         },
153         "output": {
154           "rules": [
155             {
156               "name": "foo",
157               "valid": true,
158               "validArray": [
159                 "foo"
160               ],
161               "failureReason": "RULE_FAILED",
162               "error": "foo"
163             }
164           ]
165         }
166       }
167     ],
168     "workflow": {
169       "object": "workflow",
170       "id": "workflow_BMlfq_yWM3sT-ZzvCnA3f",
171       "version": "draft",
172       "name": "Invoice Processing"
173     },
174     "batchId": "batch_7Ws31-F5",
175     "failureReason": "foo",
176     "failureMessage": "foo",
177     "reviewedBy": "jane.doe@example.com",
178     "rejectionNote": "foo",
179     "reviewedAt": "2024-03-21T16:45:00Z",
180     "startTime": "2024-03-21T15:30:00Z",
181     "endTime": "2024-03-21T15:35:00Z"
182   }
183 }

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

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

Path parameters

Headers

Response

Errors