Animationsexport abbrechen
Generierte Referenz für POST /animation-exports/{job_id}/cancel: Authentifizierung, Felder, Antworten, Fehler und sichere Nutzung.
Auf dieser Seite
Operation
POST /animation-exports/{job_id}/cancel
operationId: cancel_animation_export_v1_animation_exports__job_id__cancel_post
Fordert einen bestmöglichen Abbruch eines eigenen Auftrags an. Frage weiter ab, solange der zurückgegebene Zustand nicht endgültig ist. Bereits ausgeführte Arbeit kann berechnet bleiben; ungenutzte Reservierungen werden freigegeben. Frühere Ausgaben können erhalten bleiben. Versprich keine vollständige Erstattung.
Authentifizierung und Nebenwirkungen
Verwende einen serverseitigen Bearer-API-Schlüssel. Erforderliche Berechtigung: animations:write
Diese Operation startet keine kostenpflichtige Generierung. Andere Zustandsänderungen sind oben beschrieben.
Parameter
| Parameter | Position | Typ | Erforderlich | Einschränkungen / Standardwert | Bedeutung |
|---|---|---|---|---|---|
job_id |
path |
string |
Ja | format: uuid |
Owned public resource UUID; task, asset, and file IDs are not interchangeable. |
Antworten
| HTTP | Inhalt | Bedeutung |
|---|---|---|
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. |
Antwort-Header
| HTTP | Header | Typ | Bedeutung |
|---|---|---|---|
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. |
Beispielantwort
{
"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"
}
Weiterführende Anleitungen
Statusabfragen und Downloads · Fehler und sichere Wiederholungen
War diese Seite hilfreich?
Es werden keine Suchbegriffe, Codes oder Freitexte erfasst. Dieser Schalter steuert nur Dokumentationsinteraktionen; allgemeine Website-Analysen folgen der Datenschutzerklärung. Datenschutzerklärung