Cancel animation export
Source-generated POST /animation-exports/{job_id}/cancel reference: authentication, fields, responses, errors, and operational safeguards.
On this page
Operation
POST /animation-exports/{job_id}/cancel
operationId: cancel_animation_export_v1_animation_exports__job_id__cancel_post
Request best-effort cancellation of an owned task. The result may still be nonterminal; continue polling. Completed work can remain charged, unspent holds may be released, and earlier outputs may survive. Do not promise a full refund.
Authentication and side effects
Use a server-side Bearer API key. Required scope: animations:write
This operation does not start paid generation. Other state changes are described above.
Parameters
| Parameter | Location | Type | Required | Constraints / default | Meaning |
|---|---|---|---|---|---|
job_id |
path |
string |
Yes | format: uuid |
Owned public resource UUID; task, asset, and file IDs are not interchangeable. |
Responses
| HTTP | Body | Meaning |
|---|---|---|
200 |
TaskResponse | Successful public response. Example values are illustrative. |
400 |
APIErrorEnvelope | Invalid input; correct the request before retrying. |
401 |
APIErrorEnvelope | Missing, expired, or revoked API key. |
403 |
APIErrorEnvelope | Account eligibility, account status, or key scope does not allow this operation. |
404 |
APIErrorEnvelope | Resource is unavailable, not owned, or its signature is invalid/expired. |
429 |
APIErrorEnvelope | Account-wide rate or queue limit; wait for Retry-After. |
500 |
APIErrorEnvelope | Internal failure; preserve the task/key and retry only when marked retryable. |
503 |
APIErrorEnvelope | Service/provider unavailable; retry only when error.retryable is true. |
Response headers
| HTTP | Header | Type | Meaning |
|---|---|---|---|
429 |
Retry-After |
integer |
Suggested wait in seconds; respect the server value and an overall deadline. |
503 |
Retry-After |
integer |
Suggested wait in seconds; respect the server value and an overall deadline. |
Response example
{
"created_at": "2026-08-30T00:00:00Z",
"credits": {
"charged": 0,
"held": 1,
"quoted": 1
},
"error": null,
"finished_at": null,
"id": "00000000-0000-4000-8000-000000000002",
"metadata": {},
"normalized_input": {},
"object": "animation_export",
"outputs": [],
"progress": 0,
"stage": "queued",
"started_at": null,
"status": "cancelling"
}
Related guides
Was this page helpful?
No search queries, code, or free text are collected. This switch controls documentation interactions only; general site analytics follow the privacy policy. Privacy policy