Pekerjaan asinkron
Batalkan task
Batalkan task asinkron yang masih antre ketika provider dan model mendukungnya
Ringkasan
Gunakan DELETE /v1/tasks/{id} untuk membatalkan task asinkron yang belum mulai berjalan. Gunakan task ID yang sama dari respons create atau dari poll_url.
Task yang didukung
Task Seedance dalam antrean dengan seedance-1.5-pro, seedance-2.0, seedance-2.0-fast, atau seedance-2.5 dapat dibatalkan jika task mendukungnya. Task yang sudah berjalan atau berstatus akhir tidak dapat dibatalkan. Status dapat ditanyakan selama catatan task publik masih disimpan.
Parameter path
Async task ID yang dikembalikan oleh permintaan create atau tertanam di poll_url.
Respons
Identifier async task kanonis.
Alias identifier async task.
Polling URL yang disarankan untuk task. Tetap valid setelah pembatalan.
Status task. Task yang berhasil dibatalkan dikembalikan sebagai failed dengan cancelled: true agar kompatibel dengan nilai status yang ada.
true ketika task dibatalkan sebelum eksekusi.
Penanda pembatalan. Nilainya cancelled ketika pembatalan berhasil.
Alasan pembatalan atau pesan kegagalan task.
Perilaku error
400 unsupported_task_cancel berarti tipe task, provider, atau model tidak mendukung pembatalan. 409 task_not_cancellable berarti task sudah diproses, sudah terminal, atau tidak lagi dapat dibatalkan. 403 berarti API key tidak dapat mengakses task.
Contoh
Permintaan
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"
}{ "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"}Otorisasi
BearerAuth Autentikasi API Key. Buat atau kelola API key di Dashboard > API > API Keys.
Lokasi: header
Parameter path
ID tugas asinkron yang dikembalikan oleh id / task_id, atau disematkan dalam poll_url
Respons
application/json
application/json
application/json
application/json
application/json
application/json
application/json