Cancel Processor Run

1 curl -X POST https://api.extend.ai/processor_runs/processor_run_id_here/cancel \ 2 -H "x-extend-api-version: " \ 3 -H "Authorization: Bearer <token>"

1 { 2 "success": true, 3 "processorRun": { 4 "object": "document_processor_run", 5 "id": "dpr_Xj8mK2pL9nR4vT7qY5wZ", 6 "processorId": "dp_SmJyN3LMx9kW_YmFTxTha", 7 "processorVersionId": "dpv_YrgxmNn83sAO0JChhmLpa", 8 "processorName": "My Processor", 9 "status": "CANCELLED", 10 "output": {}, 11 "reviewed": false, 12 "edited": false, 13 "edits": {}, 14 "type": "CLASSIFY", 15 "config": { 16 "type": "CLASSIFY", 17 "classifications": [ 18 { 19 "id": "my_unique_id", 20 "type": "invoice", 21 "description": "An invoice is a document that lists the items purchased and the total amount due." 22 } 23 ] 24 }, 25 "files": [ 26 { 27 "object": "file", 28 "id": "file_xK9mLPqRtN3vS8wF5hB2cQ", 29 "name": "Invoices.pdf", 30 "metadata": {}, 31 "createdAt": "2024-03-21T15:30:00Z", 32 "updatedAt": "2024-03-21T16:45:00Z" 33 } 34 ], 35 "mergedProcessors": [ 36 { 37 "processorId": "dp_Xj8mK2pL9nR4vT7qY5wZ", 38 "processorVersionId": "dpv_Xj8mK2pL9nR4vT7qY5wZ", 39 "processorName": "Invoice Line Items Processor" 40 } 41 ], 42 "url": "https://dashboard.extend.ai/runs/dpr_Xj8mK2pL9nR4vT7qY5wZ" 43 } 44 }

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

Cancel Processor Run

Authentication

Path parameters

Headers

Response

Errors