アニメーションを中止
POST /animations/{animation_id}/cancelの認証、フィールド、応答、エラー、安全な運用をソースから生成した参考資料です。
このページの目次
操作
POST /animations/{animation_id}/cancel
operationId: cancel_one_click_animation_v1_animations__animation_id__cancel_post
所有するタスクの中止を可能な範囲で要求します。返された状態が途中なら確認を続けます。実施済み作業の請求が残り、未使用予約が解放され、先の成果物が残る場合があります。全額返還を保証しないでください。
認証と副作用
サーバー側のBearer APIキーを使います。必要な権限：animations:write
有料生成は始めません。ほかの状態変更は上記を確認してください。
パラメータ
| パラメータ | 位置 | 型 | 必須 | 制約／既定値 | 説明 |
|---|---|---|---|---|---|
animation_id |
path |
string |
はい | format: uuid |
Owned public resource UUID; task, asset, and file IDs are not interchangeable. |
応答
| HTTP | 本文 | 説明 |
|---|---|---|
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. |
応答ヘッダー
| HTTP | ヘッダー | 型 | 説明 |
|---|---|---|---|
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. |
応答例
{
"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",
"outputs": [],
"progress": 0,
"stage": "queued",
"started_at": null,
"status": "cancelling"
}
関連ガイド
この記事は役に立ちましたか？
検索語句、コード、自由記述は収集しません。この設定はドキュメントの操作イベントのみを制御します。 プライバシーポリシー