Cancel Workflow Run

POST

/workflow_runs/:id/cancel

POST

/workflow_runs/:id/cancel

1 import { ExtendClient, ExtendEnvironment } from "extend-ai";
2 
3 async function main() {
4     const client = new ExtendClient({
5         environment: ExtendEnvironment.Production,
6         token: "YOUR_TOKEN_HERE",
7     });
8     await client.workflowRuns.cancel("workflow_run_id_here");
9 }
10 main();

1 {
2   "object": "workflow_run",
3   "id": "workflow_run_xKm9pNv3qWsY_jL2tR5Dh",
4   "workflow": {
5     "object": "workflow",
6     "id": "workflow_BMlfq_yWM3sT-ZzvCnA3f",
7     "name": "Invoice Processing"
8   },
9   "workflowVersion": {
10     "object": "workflow_version",
11     "id": "workflow_version_Zk9mNP12Qw4-yTv8BdR3H",
12     "version": "3",
13     "name": "Invoice Processing"
14   },
15   "dashboardUrl": "https://dashboard.extend.ai/workflows/workflow_run_xKm9pNv3qWsY_jL2tR5Dh",
16   "status": "PENDING",
17   "metadata": {},
18   "batchId": "batch_7Ws31-F5",
19   "files": [
20     {
21       "object": "file",
22       "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
23       "name": "Invoices.pdf",
24       "type": "PDF",
25       "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
26       "metadata": {
27         "pageCount": 30,
28         "parentSplit": {
29           "id": "string",
30           "type": "Invoice",
31           "identifier": "other_2_9",
32           "startPage": 1,
33           "endPage": 10
34         }
35       },
36       "createdAt": "2024-03-21T16:45:00Z",
37       "updatedAt": "2024-03-21T16:45:00Z"
38     }
39   ],
40   "failureReason": "string",
41   "failureMessage": "string",
42   "initialRunAt": "2025-04-28T17:01:39.285Z",
43   "reviewedByUser": "jane.doe@example.com",
44   "reviewed": true,
45   "rejectionNote": "string",
46   "reviewedAt": "2024-03-21T16:45:00Z",
47   "startTime": "2024-03-21T15:30:00Z",
48   "endTime": "2024-03-21T15:35:00Z",
49   "stepRuns": [
50     {
51       "object": "workflow_step_run",
52       "id": "workflow_step_run_xK9mLPqRtN3vS8wF5hB2cQ",
53       "workflowRunId": "workflow_run_xKm9pNv3qWsY_jL2tR5Dh",
54       "status": "PROCESSED",
55       "files": [
56         {
57           "object": "file",
58           "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
59           "name": "Invoices.pdf",
60           "type": "PDF",
61           "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
62           "metadata": {
63             "pageCount": 30,
64             "parentSplit": {
65               "id": "string",
66               "type": "Invoice",
67               "identifier": "other_2_9",
68               "startPage": 1,
69               "endPage": 10
70             }
71           },
72           "createdAt": "2024-03-21T16:45:00Z",
73           "updatedAt": "2024-03-21T16:45:00Z"
74         }
75       ],
76       "step": {
77         "object": "workflow_step",
78         "id": "step_xK9mLPqRtN3vS8wF5hB2cQ",
79         "name": "Validate Invoice Total",
80         "type": "PARSE"
81       },
82       "result": {
83         "parseRun": {
84           "object": "parse_run",
85           "id": "pr_xK9mLPqRtN3vS8wF5hB2cQ",
86           "file": {
87             "object": "file",
88             "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
89             "name": "Invoices.pdf",
90             "type": "PDF",
91             "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
92             "metadata": {
93               "pageCount": 30,
94               "parentSplit": {
95                 "id": "string",
96                 "type": "Invoice",
97                 "identifier": "other_2_9",
98                 "startPage": 1,
99                 "endPage": 10
100               }
101             },
102             "createdAt": "2024-03-21T16:45:00Z",
103             "updatedAt": "2024-03-21T16:45:00Z"
104           },
105           "status": "PROCESSING",
106           "failureReason": "FILE_TYPE_NOT_SUPPORTED",
107           "failureMessage": "File type not supported for parsing.",
108           "output": {
109             "chunks": [
110               {
111                 "object": "chunk",
112                 "type": "page",
113                 "content": "This is the content of the chunk.",
114                 "metadata": {
115                   "pageRange": {
116                     "start": 1,
117                     "end": 1
118                   }
119                 },
120                 "blocks": [
121                   {
122                     "object": "block",
123                     "id": "string",
124                     "parentBlockId": "string",
125                     "type": "text",
126                     "content": "string",
127                     "details": {},
128                     "metadata": {
129                       "page": {
130                         "number": 1,
131                         "width": 1.1,
132                         "height": 1.1
133                       }
134                     },
135                     "polygon": [
136                       {
137                         "x": 10,
138                         "y": 20
139                       }
140                     ],
141                     "boundingBox": {
142                       "left": 10,
143                       "top": 10,
144                       "right": 20,
145                       "bottom": 20
146                     },
147                     "children": [
148                       null
149                     ]
150                   }
151                 ]
152               }
153             ],
154             "ocr": {
155               "words": [
156                 {
157                   "content": "string",
158                   "boundingBox": {
159                     "left": 10,
160                     "top": 10,
161                     "right": 20,
162                     "bottom": 20
163                   },
164                   "confidence": 1.1,
165                   "pageNumber": 1.1
166                 }
167               ]
168             }
169           },
170           "outputUrl": "https://...",
171           "metrics": {
172             "processingTimeMs": 1234,
173             "pageCount": 5
174           },
175           "config": {
176             "target": "markdown",
177             "chunkingStrategy": {
178               "type": "page",
179               "options": {
180                 "minCharacters": 500,
181                 "maxCharacters": 10000
182               }
183             },
184             "engine": "parse_performance",
185             "engineVersion": "latest",
186             "blockOptions": {
187               "figures": {
188                 "enabled": true,
189                 "figureImageClippingEnabled": true
190               },
191               "tables": {
192                 "enabled": true,
193                 "targetFormat": "html",
194                 "tableHeaderContinuationEnabled": false,
195                 "cellBlocksEnabled": false,
196                 "agentic": {
197                   "enabled": false,
198                   "customInstructions": "string"
199                 }
200               },
201               "text": {
202                 "signatureDetectionEnabled": false,
203                 "agentic": {
204                   "enabled": false,
205                   "customInstructions": "string"
206                 }
207               }
208             },
209             "advancedOptions": {
210               "pageRotationEnabled": true,
211               "pageRanges": [
212                 {
213                   "start": 1,
214                   "end": 10
215                 },
216                 {
217                   "start": 20,
218                   "end": 30
219                 }
220               ],
221               "excelParsingMode": "basic",
222               "excelSkipHiddenContent": false,
223               "verticalGroupingThreshold": 1,
224               "returnOcr": {
225                 "words": false
226               }
227             }
228           },
229           "usage": {
230             "credits": 10
231           }
232         }
233       }
234     }
235   ],
236   "usage": {
237     "credits": 10
238   }
239 }

Cancel a running workflow run by its ID. This endpoint allows you to stop a workflow run that is currently in progress.

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.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The ID of the workflow run.

Example: "workflow_run_xKm9pNv3qWsY_jL2tR5Dh"

Response

Successfully cancelled workflow run

objectenum

The type of object. In this case, it will always be "workflow_run".

Allowed values:

idstring

The ID of the workflow run.

Example: "workflow_run_xKm9pNv3qWsY_jL2tR5Dh"

workflowobject

workflowVersionobject

dashboardUrlstring

A URL to view this workflow run in the Extend dashboard.

Example: "https://dashboard.extend.ai/workflows/workflow_run_xKm9pNv3qWsY_jL2tR5Dh"

statusenum

The status of a workflow run:

"PENDING" - The workflow run is waiting to be processed
"PROCESSING" - The workflow run is currently processing
"NEEDS_REVIEW" - The workflow run requires manual review
"REJECTED" - The workflow run was rejected during review
"PROCESSED" - The workflow run completed successfully
"FAILED" - The workflow run encountered an error
"CANCELLED" - The workflow run was cancelled
"CANCELLING" - The workflow run is being cancelled

The status of a workflow run: * `"PENDING"` - The workflow run is waiting to be processed * `"PROCESSING"` - The workflow run is currently processing * `"NEEDS_REVIEW"` - The workflow run requires manual review * `"REJECTED"` - The workflow run was rejected during review * `"PROCESSED"` - The workflow run completed successfully * `"FAILED"` - The workflow run encountered an error * `"CANCELLED"` - The workflow run was cancelled * `"CANCELLING"` - The workflow run is being cancelled

metadatamap from strings to any

The metadata that was passed in when running the Workflow.

batchIdstring or null

The batch ID of the WorkflowRun. If this WorkflowRun was created as part of a batch of files, all runs in that batch will have the same batch ID.

Example: "batch_7Ws31-F5"

fileslist of objects

failureReasonstring or null

The reason why the workflow run failed. Will only be included if the workflow run status is "FAILED".

failureMessagestring or null

A more detailed message about the failure. Will only be included if the workflow run status is "FAILED".

initialRunAtstring or nullformat: "date-time"

The time (in UTC) at which the workflow run was created. Will follow the RFC 3339 format. Will be null if the run hasn’t started yet.

Example: "2025-04-28T17:01:39.285Z"

reviewedByUserstring or null

The email address of the person who reviewed the workflow run. Will be null if the workflow run has not been reviewed.

Example: "jane.doe@example.com"

reviewedboolean

Whether the workflow run has been reviewed.

rejectionNotestring or null

A note that is added if a workflow run is rejected.

Example: "Invalid invoice format"

reviewedAtstring or nullformat: "date-time"

The time (in UTC) at which the workflow run was reviewed. Will follow the RFC 3339 format. Will be null if the workflow run has not been reviewed.

Example: "2024-03-21T16:45:00Z"

startTimestring or nullformat: "date-time"

The time (in UTC) at which the workflow run started executing. This will always be after the initialRunAt time. Will follow the RFC 3339 format. Will be null if the workflow run has not started executing.

Example: "2024-03-21T15:30:00Z"

endTimestring or nullformat: "date-time"

The time (in UTC) that the workflow finished executing. Will follow the RFC 3339 format. Will be null if the workflow run has not finished executing.

Example: "2024-03-21T15:35:00Z"

stepRunslist of objects

An array of WorkflowStepRun objects. Each WorkflowStepRun represents a single run of a WorkflowStep and contains details about the step's execution and result.

usageobject or null

Usage credits consumed by a run.

Availability: This field will not be returned for:

Runs created before October 7, 2025
Customers on legacy billing systems

For more details on how credits work, see our Credits Guide.

Usage credits consumed by a run. **Availability:** This field will not be returned for: * Runs created before October 7, 2025 * Customers on legacy billing systems For more details on how credits work, see our [Credits Guide](https://docs.extend.ai/2026-02-09/product/general/how-credits-work).

Cancel Workflow Run

Authentication

Path parameters

Headers

Response

Errors