Cancel Workflow Run

POST

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

POST

/workflow_runs/:workflowRunId/cancel

curl -X POST https://api.extend.ai/workflow_runs/workflow_run_id_here/cancel \
     -H "x-extend-api-version: 2025-04-21" \
     -H "Authorization: Bearer <token>"

{
  "success": true,
  "workflowRun": {
    "object": "workflow_run",
    "id": "workflow_run_xKm9pNv3qWsY_jL2tR5Dh",
    "name": "myFirstFile.pdf",
    "url": "https://dashboard.extend.ai/workflows/workflow_Bk9mNp2qWs5_xL8vR4tYh?workflowRunId=workflow_run_Zj3nMx7ZPd9f4c2WQ_kAg",
    "status": "CANCELLED",
    "metadata": {},
    "files": [
      {
        "object": "file",
        "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
        "name": "Invoices.pdf",
        "metadata": {
          "pageCount": 30,
          "parentSplit": {
            "id": "string",
            "type": "Invoice",
            "identifier": "other_2_9",
            "startPage": 1,
            "endPage": 10
          }
        },
        "createdAt": "2024-03-21T15:30:00Z",
        "updatedAt": "2024-03-21T16:45:00Z",
        "type": "PDF",
        "presignedUrl": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
        "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
        "contents": {
          "rawText": "string",
          "markdown": "string",
          "pages": [
            {
              "pageNumber": 1,
              "pageHeight": 10,
              "pageWidth": 10,
              "rawText": "This is the raw text of the page.",
              "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",
              "html": "<div>This is the html of the page.</div>"
            }
          ],
          "sheets": [
            {
              "sheetName": "Sheet1",
              "rawText": "This is the raw text of the sheet."
            }
          ]
        },
        "usage": {
          "credits": 10
        }
      }
    ],
    "initialRunAt": "2025-04-28T17:01:39.285Z",
    "reviewed": true,
    "outputs": [
      {
        "object": "document_processor_run",
        "id": "dpr_Xj8mK2pL9nR4vT7qY5wZ",
        "processorId": "dp_Xj8mK2pL9nR4vT7qY5wZ",
        "processorVersionId": "dpv_Xj8mK2pL9nR4vT7qY5wZ",
        "processorName": "Invoice Processor",
        "status": "PENDING",
        "output": {},
        "reviewed": false,
        "edited": false,
        "edits": {},
        "type": "CLASSIFY",
        "config": {
          "type": "CLASSIFY",
          "baseProcessor": "classification_performance",
          "baseVersion": "3.2.0",
          "classifications": [
            {
              "id": "my_unique_id",
              "type": "invoice",
              "description": "An invoice is a document that lists the items purchased and the total amount due."
            }
          ],
          "classificationRules": "Remember, when it comes to differentiating between invoices and purchase orders, the most important thing to look for is the date of the document.",
          "advancedOptions": {
            "context": "default",
            "advancedMultimodalEnabled": false,
            "fixedPageLimit": 30,
            "pageRanges": [
              {
                "start": 1,
                "end": 10
              },
              {
                "start": 20,
                "end": 30
              }
            ]
          },
          "parser": {
            "target": "markdown",
            "chunkingStrategy": {
              "type": "page",
              "options": {
                "minCharacters": 100,
                "maxCharacters": 1000
              }
            },
            "engine": "parse_performance",
            "blockOptions": {
              "figures": {
                "enabled": true,
                "figureImageClippingEnabled": true
              },
              "tables": {
                "enabled": true,
                "targetFormat": "markdown",
                "tableHeaderContinuationEnabled": false,
                "cellBlocksEnabled": false,
                "agentic": {
                  "enabled": false,
                  "customInstructions": "string"
                }
              },
              "text": {
                "signatureDetectionEnabled": true,
                "agentic": {
                  "enabled": false,
                  "customInstructions": "string"
                }
              }
            },
            "advancedOptions": {
              "pageRotationEnabled": true,
              "agenticOcrEnabled": false,
              "pageRanges": [
                {
                  "start": 1,
                  "end": 10
                },
                {
                  "start": 20,
                  "end": 30
                }
              ],
              "excelParsingMode": "basic",
              "excelSkipHiddenContent": false,
              "excelUseRawCellValues": false,
              "excelSkipCalculation": true,
              "excelIncludeCellMetadata": false,
              "excelIncludeCellFormatting": false,
              "verticalGroupingThreshold": 1,
              "returnOcr": {
                "words": false
              },
              "alwaysConvertToPdf": false
            }
          }
        },
        "files": [
          {
            "object": "file",
            "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
            "name": "Invoices.pdf",
            "metadata": {
              "pageCount": 30,
              "parentSplit": {
                "id": "string",
                "type": "Invoice",
                "identifier": "other_2_9",
                "startPage": 1,
                "endPage": 10
              }
            },
            "createdAt": "2024-03-21T15:30:00Z",
            "updatedAt": "2024-03-21T16:45:00Z",
            "type": "PDF",
            "presignedUrl": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
            "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
            "contents": {
              "rawText": "string",
              "markdown": "string",
              "pages": [
                {
                  "pageNumber": 1,
                  "pageHeight": 10,
                  "pageWidth": 10,
                  "rawText": "This is the raw text of the page.",
                  "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",
                  "html": "<div>This is the html of the page.</div>"
                }
              ],
              "sheets": [
                {
                  "sheetName": "Sheet1",
                  "rawText": "This is the raw text of the sheet."
                }
              ]
            },
            "usage": {
              "credits": 10
            }
          }
        ],
        "mergedProcessors": [
          {
            "processorId": "dp_Xj8mK2pL9nR4vT7qY5wZ",
            "processorVersionId": "dpv_Xj8mK2pL9nR4vT7qY5wZ",
            "processorName": "Invoice Line Items Processor"
          }
        ],
        "url": "https://dashboard.extend.ai/runs/dpr_Xj8mK2pL9nR4vT7qY5wZ",
        "failureReason": "string",
        "failureMessage": "string",
        "metadata": {},
        "initialOutput": {},
        "reviewedOutput": {},
        "usage": {
          "credits": 3.5
        }
      }
    ],
    "stepRuns": [
      {
        "object": "workflow_step_run",
        "id": "workflow_step_run_xK9mLPqRtN3vS8wF5hB2cQ",
        "status": "PENDING",
        "step": {
          "object": "workflow_step",
          "id": "step_xK9mLPqRtN3vS8wF5hB2cQ",
          "name": "Validate Invoice Total",
          "type": "EXTERNAL_DATA_VALIDATION"
        },
        "output": {
          "rules": [
            {
              "name": "string",
              "valid": true,
              "validArray": [
                "string"
              ],
              "failureReason": "RULE_FAILED",
              "error": "string"
            }
          ]
        }
      }
    ],
    "workflow": {
      "object": "workflow",
      "id": "workflow_BMlfq_yWM3sT-ZzvCnA3f",
      "version": "draft",
      "name": "Invoice Processing"
    },
    "batchId": "batch_7Ws31-F5",
    "failureReason": "string",
    "failureMessage": "string",
    "reviewedBy": "jane.doe@example.com",
    "rejectionNote": "string",
    "reviewedAt": "2024-03-21T16:45:00Z",
    "startTime": "2024-03-21T15:30:00Z",
    "endTime": "2024-03-21T15:35:00Z",
    "usage": {
      "credits": 25
    }
  }
}

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

workflowRunIdstringRequired

The ID of the workflow run to cancel.

Example: "workflow_run_xKm9pNv3qWsY_jL2tR5Dh"

Response

Successfully cancelled workflow run

successboolean

workflowRunobject

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors