非同期ジョブ
タスクのキャンセル
モデルがキャンセルをサポートしている場合に、キューに入れられた非同期タスクをキャンセルします
概要
DELETE /v1/tasks/{id} を使用して、まだ実行が開始されていない非同期タスクをキャンセルします。作成時のレスポンスまたは返された poll_url に含まれるタスクIDを使用してください。
サポートされているタスク
キャンセル機能は、seedance-2.0、seedance-2.0-fast、または seedance-2.5 を使用する Seedance タスクのうち、キャンセルをサポートしているタスクで利用可能です。すでに実行中、または終了状態にあるタスクはキャンセルできません。キャンセルされたタスクには課金されません。パブリックなタスクレコードが保持されている間は、ステータスの照会が可能です。
Volc 互換の Seedance エンドポイントを通じて作成されたタスクをキャンセルする方法については、タスクのキャンセル (Volc 互換) を参照してください。
パスパラメータ
作成リクエストによって返された、または poll_url に埋め込まれた非同期タスクID。
レスポンス
正規の非同期タスク識別子。
非同期タスク識別子のエイリアス。
タスクのステータス URL。キャンセル後も有効です。id を指定して GET /v1/tasks/{id} をポーリングしてください。
タスクのステータス。正常にキャンセルされたタスクは、既存のステータス値との互換性を保つため、cancelled: true を伴う failed として返されます。
実行前にタスクがキャンセルされた場合に true となります。
キャンセルマーカー。キャンセルが成功した場合、値は cancelled になります。
キャンセルの理由またはタスクの失敗メッセージ。
エラー動作
| HTTP | Code | 意味 |
|---|---|---|
400 | missing_task_id, invalid_task_id | タスクIDが欠落しているか、有効なタスクIDではありません |
400 | unsupported_task_cancel | タスクタイプまたはモデルがキャンセルをサポートしていません |
403 | task_not_owned | タスクがこの API キーのワークスペースに属していません |
404 | async_task_not_found | タスクの有効期限が切れているか、利用できません |
409 | task_not_cancellable | タスクはすでに処理中、完了済み、またはキャンセル不可能な状態です。current_status で現在の状態を確認できます |
503 | async_task_owner_unavailable | 現在タスクを読み取ることができません。再試行してください |
リクエスト
curl -X DELETE "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
-H "Authorization: Bearer sk-your-api-key"レスポンス
{
"id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"task_id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"poll_url": "/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"status": "failed",
"cancelled": true,
"cancellation_status": "cancelled",
"error": "Task cancelled before execution"
}認証
BearerAuth APIキー認証。Dashboard > API > API KeysでAPIキーを作成または管理します。
場所: header
パスパラメータ
id / task_id によって返される、または poll_url に埋め込まれた非同期タスクID
レスポンス
application/json
application/json
application/json
application/json
application/json
application/json
application/json