動画をキャンセル
進行中の動画生成タスクをキャンセルします。タスクをキャンセルできるのは実行中の間だけです。終端状態(completed、failed、cancelled、expired)に到達すると、もうキャンセルできません。
DELETE https://api.ofox.ai/v1/videos/{id}キャンセル可否はアップストリームプロバイダーに依存します。Ofox は、アップストリームプロバイダーが実際に中断に対応している場合のみキャンセルリクエストを受け付けます。アップストリームが生成を続けているのに、ローカルでタスクを cancelled にするような偽の成功は返しません。実行中ジョブを中断できないプロバイダーは 400 cancel_not_supported を返します。
リクエスト
curl -X DELETE https://api.ofox.ai/v1/videos/9bcf3c60-7db2-4e1a-a1b2-c3d4e5f60718 \
-H "Authorization: Bearer $OFOX_API_KEY"レスポンス
キャンセルに成功すると、空の body で 204 No Content を返します。
HTTP/1.1 204 No Contentキャンセル成功後、タスクの status は cancelled になります。その後、GET /v1/videos/{id} をポーリングすると cancelled 終端状態が返り、callback_url を登録していた場合は video.generation.cancelled webhook も受け取ります。
キャンセル動作
キャンセルが受理されるかどうかは、タスクの現在状態と、アップストリームプロバイダーが中断に対応しているかに依存します:
| タスク状態 | 動作 | レスポンス |
|---|---|---|
pending(まだアップストリームへ送信されていない) | ローカルでキャンセル | 204 |
queued / in_progress、プロバイダーが中断に対応 | アップストリームのキャンセルを呼び出し、成功後にタスクを cancelled としてマーク | 204 |
queued / in_progress、プロバイダーが中断に非対応 | 拒否(偽の成功なし) | 400 cancel_not_supported |
| すでに終端状態 | 拒否 | 400 cancel_failed |
| 見つからない / あなたの key が所有していない | 統一レスポンス(存在の開示を防止) | 404 not_found |
存在しないタスクと、別の API key が所有するタスクは同じ 404 not_found を返すため、レスポンスから特定の task id が存在するかどうかは分かりません。
エラー
| HTTP | code | 意味 |
|---|---|---|
400 | cancel_not_supported | アップストリームプロバイダーが実行中ジョブの中断に対応していません |
400 | cancel_failed | タスクはすでに終端状態で、キャンセルできません |
404 | not_found | タスクが存在しない、またはあなたの API key が所有していません |
エラーは共通の error object を使用します:
{
"error": {
"code": "cancel_not_supported",
"message": "The upstream provider for this task does not support cancellation."
}
}すべてのコードについては完全な error reference をご覧ください。DELETE は GET に適用されるポーリングレート制限の対象外です。詳細は 動画ステータスの取得 をご覧ください。