Asenkron işler

Görevi iptal et

Sağlayıcı ve model desteklediğinde kuyruktaki asenkron görevi iptal edin

DELETE
/v1/tasks/{id}

Genel bakış

Henüz çalışmaya başlamamış bir asenkron görevi iptal etmek için DELETE /v1/tasks/{id} kullanın. create yanıtındaki görev ID’sini veya poll_url içindeki aynı ID’yi kullanın.

Desteklenen görevler

İptali destekleyen kuyruktaki Seedance görevlerinde seedance-1.5-pro, seedance-2.0, seedance-2.0-fast veya seedance-2.5 kullanılabilir. Çalışan veya nihai durumdaki görevler iptal edilemez. Genel görev kaydı saklandığı sürece durum sorgulanabilir.

Yol parametreleri

idstringpathzorunlu

create isteği tarafından döndürülen veya poll_url içinde bulunan asenkron görev ID’si.

Yanıt

idstring

Kanonik asenkron görev tanımlayıcısı.

task_idstring

Asenkron görev tanımlayıcısı takma adı.

poll_urlstring

Görev için tercih edilen polling URL’si. İptalden sonra da geçerlidir.

statusstring

Görev durumu. Başarıyla iptal edilen görev, mevcut durum değerleriyle uyumluluk için failed ve cancelled: true olarak döner.

cancelledboolean

Görev yürütülmeden önce iptal edildiyse true.

cancellation_statusstring

İptal işareti. İptal başarılı olduğunda değer cancelled olur.

errorstring

İptal nedeni veya görev hata mesajı.

Hata davranışı

400 unsupported_task_cancel, görev türü, sağlayıcı veya modelin iptali desteklemediği anlamına gelir. 409 task_not_cancellable, görevin zaten işlendiği, terminal durumda olduğu veya artık iptal edilemediği anlamına gelir. 403, API key’in göreve erişemediği anlamına gelir.

Örnek

İstek

cURL
curl -X DELETE "https://api.tokenlab.sh/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"
}
{  "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"}

Yetkilendirme

BearerAuth
AuthorizationBearer <token>

API Anahtarı kimlik doğrulaması. API anahtarlarını Dashboard > API > API Keys bölümünden oluşturun veya yönetin.

Konum: header

Yol parametreleri

id*string

id / task_id tarafından döndürülen veya poll_url içine gömülü olan asenkron görev kimliği

Yanıt

application/json

application/json

application/json

application/json

application/json

application/json

application/json