メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.lemondata.cc/llms.txt

Use this file to discover all available pages before exploring further.

概要

DELETE /v1/tasks/{id} を使って、まだ実行開始していない非同期タスクをキャンセルします。create レスポンスのタスク ID、または poll_url に含まれる同じ ID を使用してください。

対応タスク

現在キャンセルに対応しているのは、キュー中の Volcengine Seedance 動画タスクで、モデルは seedance-1.5-proseedance-2.0seedance-2.0-fast です。すでに processing/running になったタスクはキャンセルできません。完了、失敗、期限切れ、未対応のタスクは、ステータス確認と課金照合のために引き続き参照可能にし、上流レコードは削除しません。

パスパラメーター

id
string
必須
create リクエストで返された、または poll_url に含まれる非同期タスク ID。

レスポンス

id
string
正規の非同期タスク識別子。
task_id
string
非同期タスク識別子のエイリアス。
poll_url
string
タスクの推奨ポーリング URL。キャンセル後も有効です。
status
string
タスクステータス。正常にキャンセルされたタスクは、既存のステータス値との互換性のため failed として返され、cancelled: true が付きます。
cancelled
boolean
タスクが実行前にキャンセルされた場合は true です。
cancellation_status
string
キャンセルマーカー。キャンセル成功時の値は cancelled です。
error
string
キャンセル理由またはタスク失敗メッセージ。

エラー動作

400 unsupported_task_cancel は、タスク種別、プロバイダー、またはモデルがキャンセルに対応していないことを示します。409 task_not_cancellable は、タスクがすでに処理中、終端状態、またはキャンセル不能であることを示します。403 は API key がそのタスクにアクセスできないことを示します。

curl -X DELETE "https://api.lemondata.cc/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
  -H "Authorization: Bearer sk-your-api-key"
Response
{
  "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"
}