الانتقال إلى المحتوى الرئيسي

​
نظرة عامة

استخدم نقطة النهاية هذه للاستطلاع غير المتزامن الموحّد عبر أنواع المهام مثل إنشاء الفيديو والصورة والموسيقى و3D. إذا كانت استجابة الإنشاء تتضمن poll_url، فاستدعِ ذلك المسار نفسه تمامًا. بالنسبة لسير العمل غير المتزامن الأحدث، قد يشير poll_url إلى /v1/tasks/{id}.

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

​
id
string
مطلوب
معرّف المهمة المُعاد من طلب الإنشاء.

​
الاستجابة

​
id
string
معرّف المهمة.
​
task_id
string
اسم مستعار لمعرّف المهمة غير المتزامنة.
​
poll_url
string
عنوان URL المفضل للاستعلام عندما توفره استجابة الإنشاء.
​
status
string
حالة المهمة مثل pending أو processing أو completed أو failed. يتم تمثيل المهام الملغاة كـ failed مع cancelled: true.
​
cancelled
boolean
true عندما يتم إلغاء مهمة غير متزامنة في قائمة الانتظار قبل التنفيذ.
​
cancellation_status
string
مؤشر الإلغاء. يظهر كـ cancelled عند نجاح الإلغاء.
​
data
array
بالنسبة لمهام الصور المكتملة، تُعاد نتائج الصور التي تم إنشاؤها هنا. تعيد مهام الصور روابط URL في data[].url.
​
progress
number
قيمة تقدم اختيارية. لا تُعاد إلا عند توفر قيمة تقدم حقيقية؛ استخدم status لتحديد اكتمال المهمة.
​
video_url
string
URL الأصل الناتج عند اكتمال المهمة وإنتاج فيديو.
​
error
string
رسالة الخطأ عند فشل المهمة.

​
سلوك الخطأ

إذا لم تعد المهمة موجودة، أو انتهت صلاحيتها، أو تعذر حلها عبر عقد المهمة غير المتزامنة العام، فستعيد TokenLab: 
{
  "error": {
    "message": "Task not found or no longer available.",
    "type": "invalid_request_error",
    "code": "async_task_not_found"
  }
}

​
أمثلة

curl "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
  -H "Authorization: Bearer sk-your-api-key"
Python
import requests

poll_url = "/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
response = requests.get(
    f"https://api.tokenlab.sh{poll_url}",
    headers={"Authorization": "Bearer sk-your-api-key"},
)
print(response.json())
JavaScript
const pollUrl = '/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa';
const response = await fetch(`https://api.tokenlab.sh${pollUrl}`, {
  headers: { Authorization: 'Bearer sk-your-api-key' },
});
console.log(await response.json());