Pekerjaan asinkron
Membatalkan Tugas
Membatalkan tugas asinkron yang berada dalam antrean jika modelnya mendukung pembatalan
Gambaran Umum
Gunakan DELETE /v1/tasks/{id} untuk membatalkan tugas asinkron yang belum mulai berjalan. Gunakan ID tugas yang sama dari respons pembuatan atau poll_url yang dikembalikan.
Tugas yang Didukung
Pembatalan tersedia untuk tugas Seedance yang berada dalam antrean menggunakan seedance-2.0, seedance-2.0-fast, atau seedance-2.5 jika tugas tersebut mendukung pembatalan. Tugas yang sudah berjalan atau berada dalam status terminal tidak dapat dibatalkan. Tugas yang dibatalkan tidak dikenakan biaya. Status tetap dapat dikueri selama catatan tugas publiknya disimpan.
Untuk membatalkan tugas yang dibuat melalui endpoint Seedance yang kompatibel dengan Volc, lihat Membatalkan Tugas (Kompatibel dengan Volc).
Parameter Jalur
ID tugas asinkron yang dikembalikan oleh permintaan pembuatan atau yang disematkan dalam poll_url.
Respons
Pengidentifikasi tugas asinkron kanonik.
Alias pengidentifikasi tugas asinkron.
URL status untuk tugas tersebut. URL ini tetap valid setelah pembatalan. Lakukan polling GET /v1/tasks/{id} dengan id.
Status tugas. Tugas yang berhasil dibatalkan akan dikembalikan sebagai failed dengan cancelled: true untuk kompatibilitas dengan nilai status yang ada.
true jika tugas dibatalkan sebelum eksekusi.
Penanda pembatalan. Nilainya adalah cancelled jika pembatalan berhasil.
Alasan pembatalan atau pesan kegagalan tugas.
Perilaku Kesalahan
| HTTP | Kode | Arti |
|---|---|---|
400 | missing_task_id, invalid_task_id | ID tugas tidak ada atau bukan ID tugas yang valid |
400 | unsupported_task_cancel | Jenis tugas atau model tidak mendukung pembatalan |
403 | task_not_owned | Tugas tidak termasuk dalam ruang kerja API key ini |
404 | async_task_not_found | Tugas telah kedaluwarsa atau tidak tersedia |
409 | task_not_cancellable | Tugas sedang diproses, sudah selesai, atau tidak dapat dibatalkan lagi. current_status memberikan statusnya saat ini |
503 | async_task_owner_unavailable | Tugas tidak dapat dibaca saat ini. Coba lagi |
Permintaan
curl -X DELETE "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
-H "Authorization: Bearer sk-your-api-key"Respons
{
"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