POST /v1/processing-runs/{run_id}/cancel

← API referenceFile intelligence · API access unavailable

API REFERENCE / FILE INTELLIGENCE

`POST` /v1/processing-runs/{run_id}/cancel

Request cancellation of remaining processing work.

Request fields

Location	Field	Type	Required	Description
Header	`Authorization`	string	Yes	Credential scoped to the authorized resource.
Path	`run_id`	string	Yes	Existing processing run.
Header	`Idempotency-Key`	string	Yes	Stable retry identity for the cancellation.

Request example

Example request

POST /v1/processing-runs/run_123/cancel
Authorization: Bearer <analysis-manage token>
Idempotency-Key: cancel-run-8427

HTTP status codes

Status	Meaning
`202 Accepted`	Success response shown below.
`401 Unauthorized`	Missing, expired, or invalid credential.
`403 Forbidden`	Credential is valid but lacks the required scope or role.
`404 Not Found`	Run is not visible to this caller.
`409 Conflict`	Run is already terminal; inspect its final status.
`429 Too Many Requests`	Rate limit reached; honor Retry-After when provided.
`503 Service Unavailable`	Service temporarily unavailable; retry safely.

Response fields

Field	Type	Example
`run_id`	string	run_123
`status`	string (enum)	cancellation_requested Allowed values · closed enum`queuedrunningcancellation_requestedcompletedpartially_completedfailedcancelled`
`updated_at`	string (date-time)	2026-10-20T18:04:05Z

Response example

Example response

202 Accepted
Content-Type: application/json

{
  "run_id": "run_123",
  "status": "cancellation_requested",
  "updated_at": "2026-10-20T18:04:05Z"
}

How it works

Cancellation is a race with completion. It does not roll back outputs already published; inspect the run and artifact list afterward. Retrying with the same key must not create a second cancellation.