Cancel Processor Run

import { ExtendClient, ExtendEnvironment } from "extend-ai";
async function main() {
    const client = new ExtendClient({
        environment: ExtendEnvironment.Production,
        token: "YOUR_TOKEN_HERE",
    });
    await client.processorRun.cancel("processor_run_id_here");
}
main();

{
  "success": true,
  "processorRun": {
    "object": "document_processor_run",
    "id": "exr_Xj8mK2pL9nR4vT7qY5wZ",
    "processorId": "ex_Xj8mK2pL9nR4vT7qY5wZ",
    "processorVersionId": "exv_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": 500,
            "maxCharacters": 10000
          }
        },
        "engine": "parse_performance",
        "engineVersion": "latest",
        "blockOptions": {
          "figures": {
            "enabled": true,
            "figureImageClippingEnabled": true
          },
          "tables": {
            "enabled": true,
            "targetFormat": "html",
            "tableHeaderContinuationEnabled": false,
            "cellBlocksEnabled": false,
            "agentic": {
              "enabled": false,
              "customInstructions": "string"
            }
          },
          "text": {
            "signatureDetectionEnabled": false,
            "agentic": {
              "enabled": false,
              "customInstructions": "string"
            }
          }
        },
        "advancedOptions": {
          "pageRotationEnabled": true,
          "pageRanges": [
            {
              "start": 1,
              "end": 10
            },
            {
              "start": 20,
              "end": 30
            }
          ],
          "excelParsingMode": "basic",
          "excelSkipHiddenContent": false,
          "verticalGroupingThreshold": 1,
          "returnOcr": {
            "words": false
          }
        }
      }
    },
    "files": [
      {
        "object": "file",
        "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
        "name": "Invoices.pdf",
        "type": "PDF",
        "presignedUrl": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
        "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
        "metadata": {
          "pageCount": 30,
          "parentSplit": {
            "id": "string",
            "type": "Invoice",
            "identifier": "other_2_9",
            "startPage": 1,
            "endPage": 10
          }
        },
        "createdAt": "2024-03-21T16:45:00Z",
        "updatedAt": "2024-03-21T16:45:00Z",
        "contents": {
          "rawText": "string",
          "pages": [
            {
              "pageNumber": 1,
              "pageHeight": 792,
              "pageWidth": 612,
              "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>"
            }
          ],
          "sections": [
            {
              "startPageNumber": 1,
              "endPageNumber": 3,
              "markdown": "# Section Header\n\nContent spanning multiple pages...\n"
            }
          ],
          "sheets": [
            {
              "sheetName": "Sheet1",
              "rawText": "Column1,Column2\nValue1,Value2"
            }
          ]
        }
      }
    ],
    "mergedProcessors": [
      {
        "processorId": "ex_Xj8mK2pL9nR4vT7qY5wZ",
        "processorVersionId": "exv_Xj8mK2pL9nR4vT7qY5wZ",
        "processorName": "Invoice Line Items Processor"
      }
    ],
    "url": "https://dashboard.extend.ai/runs/exr_Xj8mK2pL9nR4vT7qY5wZ",
    "failureReason": "string",
    "failureMessage": "string",
    "metadata": {},
    "initialOutput": {},
    "reviewedOutput": {},
    "usage": {
      "credits": 3.5
    }
  }
}

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

Note: Only processor runs with a status of "PROCESSING" can be cancelled. Processor runs that have already completed, failed, or been cancelled cannot be cancelled again.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The unique identifier for the processor run to cancel.

Example: "exr_Xj8mK2pL9nR4vT7qY5wZ"

Response

Successfully cancelled processor run

successboolean

processorRunobject

Cancel Processor Run

Authentication

Path parameters

Headers

Response

Errors