Cancel Processor Run

from extend_ai import Extend
client = Extend(
    token="YOUR_TOKEN_HERE",
    extend_api_version="2025-04-21",
)
client.processor_run.cancel(
    id="processor_run_id_here",
)

{
  "success": true,
  "processorRun": {
    "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,
          "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
    }
  }
}

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.

from extend_ai import Extend
client = Extend(
    token="YOUR_TOKEN_HERE",
    extend_api_version="2025-04-21",
)
client.processor_run.cancel(
    id="processor_run_id_here",
)

{
  "success": true,
  "processorRun": {
    "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,
          "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
    }
  }
}

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: "dpr_Xj8mK2pL9nR4vT7qY5wZ"

Response

Successfully cancelled processor run

successboolean

processorRunobject

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

Cancel Processor Run

Cancel Processor Run

Authentication

Path parameters

Headers

Response

Errors

Authentication

Path parameters

Headers

Response

Errors

1	from extend_ai import Extend
2
3	client = Extend(
4	token="YOUR_TOKEN_HERE",
5	extend_api_version="2025-04-21",
6	)
7
8	client.processor_run.cancel(
9	id="processor_run_id_here",
10	)

1	{
2	"success": true,
3	"processorRun": {
4	"object": "document_processor_run",
5	"id": "dpr_Xj8mK2pL9nR4vT7qY5wZ",
6	"processorId": "dp_Xj8mK2pL9nR4vT7qY5wZ",
7	"processorVersionId": "dpv_Xj8mK2pL9nR4vT7qY5wZ",
8	"processorName": "Invoice Processor",
9	"status": "PENDING",
10	"output": {},
11	"reviewed": false,
12	"edited": false,
13	"edits": {},
14	"type": "CLASSIFY",
15	"config": {
16	"type": "CLASSIFY",
17	"baseProcessor": "classification_performance",
18	"baseVersion": "3.2.0",
19	"classifications": [
20	{
21	"id": "my_unique_id",
22	"type": "invoice",
23	"description": "An invoice is a document that lists the items purchased and the total amount due."
24	}
25	],
26	"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.",
27	"advancedOptions": {
28	"context": "default",
29	"advancedMultimodalEnabled": false,
30	"fixedPageLimit": 30,
31	"pageRanges": [
32	{
33	"start": 1,
34	"end": 10
35	},
36	{
37	"start": 20,
38	"end": 30
39	}
40	]
41	},
42	"parser": {
43	"target": "markdown",
44	"chunkingStrategy": {
45	"type": "page",
46	"options": {
47	"minCharacters": 100,
48	"maxCharacters": 1000
49	}
50	},
51	"engine": "parse_performance",
52	"blockOptions": {
53	"figures": {
54	"enabled": true,
55	"figureImageClippingEnabled": true
56	},
57	"tables": {
58	"enabled": true,
59	"targetFormat": "markdown",
60	"tableHeaderContinuationEnabled": false,
61	"cellBlocksEnabled": false,
62	"agentic": {
63	"enabled": false,
64	"customInstructions": "string"
65	}
66	},
67	"text": {
68	"signatureDetectionEnabled": true,
69	"agentic": {
70	"enabled": false,
71	"customInstructions": "string"
72	}
73	}
74	},
75	"advancedOptions": {
76	"pageRotationEnabled": true,
77	"agenticOcrEnabled": false,
78	"pageRanges": [
79	{
80	"start": 1,
81	"end": 10
82	},
83	{
84	"start": 20,
85	"end": 30
86	}
87	],
88	"excelParsingMode": "basic",
89	"excelSkipHiddenContent": false,
90	"excelUseRawCellValues": false,
91	"excelSkipCalculation": true,
92	"verticalGroupingThreshold": 1,
93	"returnOcr": {
94	"words": false
95	},
96	"alwaysConvertToPdf": false
97	}
98	}
99	},
100	"files": [
101	{
102	"object": "file",
103	"id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
104	"name": "Invoices.pdf",
105	"metadata": {
106	"pageCount": 30,
107	"parentSplit": {
108	"id": "string",
109	"type": "Invoice",
110	"identifier": "other_2_9",
111	"startPage": 1,
112	"endPage": 10
113	}
114	},
115	"createdAt": "2024-03-21T15:30:00Z",
116	"updatedAt": "2024-03-21T16:45:00Z",
117	"type": "PDF",
118	"presignedUrl": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
119	"parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
120	"contents": {
121	"rawText": "string",
122	"markdown": "string",
123	"pages": [
124	{
125	"pageNumber": 1,
126	"pageHeight": 10,
127	"pageWidth": 10,
128	"rawText": "This is the raw text of the page.",
129	"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",
130	"html": "<div>This is the html of the page.</div>"
131	}
132	],
133	"sheets": [
134	{
135	"sheetName": "Sheet1",
136	"rawText": "This is the raw text of the sheet."
137	}
138	]
139	},
140	"usage": {
141	"credits": 10
142	}
143	}
144	],
145	"mergedProcessors": [
146	{
147	"processorId": "dp_Xj8mK2pL9nR4vT7qY5wZ",
148	"processorVersionId": "dpv_Xj8mK2pL9nR4vT7qY5wZ",
149	"processorName": "Invoice Line Items Processor"
150	}
151	],
152	"url": "https://dashboard.extend.ai/runs/dpr_Xj8mK2pL9nR4vT7qY5wZ",
153	"failureReason": "string",
154	"failureMessage": "string",
155	"metadata": {},
156	"initialOutput": {},
157	"reviewedOutput": {},
158	"usage": {
159	"credits": 3.5
160	}
161	}
162	}