delete
/api/v2/jobs/{id}Python SDK method:
client.jobs.cancel_job(job_id)Cancel job
Requests cancellation of a job. Returns 202 Accepted; poll GET /api/v2/jobs/{id} to confirm the CANCELED status.
Input Parameters
| Name | Location | Type | Values | Description | Value Required |
|---|---|---|---|---|---|
id | path | string | - | Resource identifier. | Y |
Success Responses
202 response: object
Cancellation accepted.
| Name | Type | Description |
|---|---|---|
error | object | Details about why the job failed (RFC 7807 format), or null if it succeeded. |
id | string | Unique job identifier. |
links | object | Navigation URLs for polling and result retrieval. |
status | string | Current job lifecycle state: PENDING, QUEUED, RUNNING, DONE, FAILED, CANCELED, or NOT_FOUND. |
Response Errors
| HTTP Status Code | Reason |
|---|---|
| 400 | Problem Details error. |
| 401 | Problem Details error. |
| 429 | The request rate limit has been exceeded. |
| 500 | Problem Details error. |
