المهام غير المتزامنة

إلغاء المهمة

إلغاء مهمة غير متزامنة في قائمة الانتظار عندما يدعم الموفر والنموذج ذلك

DELETE
/v1/tasks/{id}

نظرة عامة

استخدم DELETE /v1/tasks/{id} لإلغاء مهمة غير متزامنة لم تبدأ التنفيذ بعد. استخدم نفس معرف المهمة من استجابة create أو المعرف الموجود في poll_url.

المهام المدعومة

يمكن إلغاء مهام Seedance المنتظرة التي تستخدم seedance-1.5-pro أو seedance-2.0 أو seedance-2.0-fast أو seedance-2.5 عندما تدعم المهمة الإلغاء. لا يمكن إلغاء مهمة بدأت التنفيذ أو وصلت إلى حالة نهائية. تبقى الحالة قابلة للاستعلام ما دام سجل المهمة العام محفوظًا.

معلمات المسار

idstringpathمطلوب

معرف المهمة غير المتزامنة الذي أرجعته طلب create أو الموجود في poll_url.

الاستجابة

idstring

المعرف القياسي للمهمة غير المتزامنة.

task_idstring

اسم مستعار لمعرف المهمة غير المتزامنة.

poll_urlstring

رابط polling المفضل للمهمة. يبقى صالحًا بعد الإلغاء.

statusstring

حالة المهمة. يتم إرجاع المهمة الملغاة بنجاح كـ failed مع cancelled: true للحفاظ على التوافق مع قيم الحالة الحالية.

cancelledboolean

true عندما يتم إلغاء المهمة قبل التنفيذ.

cancellation_statusstring

مؤشر الإلغاء. تكون القيمة cancelled عند نجاح الإلغاء.

errorstring

سبب الإلغاء أو رسالة فشل المهمة.

سلوك الأخطاء

400 unsupported_task_cancel يعني أن نوع المهمة أو الموفر أو النموذج لا يدعم الإلغاء. 409 task_not_cancellable يعني أن المهمة قيد المعالجة بالفعل أو في حالة نهائية أو لم تعد قابلة للإلغاء. 403 يعني أن مفتاح API لا يمكنه الوصول إلى المهمة.

مثال

الطلب

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"}

التفويض

BearerAuth
AuthorizationBearer <token>

مصادقة مفتاح API. قم بإنشاء أو إدارة مفاتيح API في Dashboard > API > API Keys.

الموضع: header

معاملات المسار

id*string

معرف المهمة غير المتزامنة الذي يتم إرجاعه بواسطة id / task_id، أو المضمن في poll_url

الاستجابة

application/json

application/json

application/json

application/json

application/json

application/json

application/json