الملفات والدفعات

إلغاء الدفعة

يلغي مهمة دفعة متوقفة أو قيد التشغيل.

POST
/v1/batches/{batch_id}/cancel

اطلب إلغاء دفعة في قائمة الانتظار أو قيد التشغيل. تتضمن الاستجابة حالتها الحالية؛ فقد يكون الإلغاء جاريًا أو قد اكتمل بالفعل. تحتفظ الدفعة المنتهية بحالتها النهائية السابقة. إذا لم تكن الحالة المعادة نهائية، فاسترجع الدفعة مرة أخرى للتحقق من النتيجة.

الطلب

cURL
curl -X POST "https://api.tokenlab.sh/v1/batches/batch_abc123/cancel" \
  -H "Authorization: Bearer sk-your-api-key"

الاستجابة

200 OK
{
  "id": "batch_abc123",
  "object": "batch",
  "status": "cancelling",
  "input_file_id": "file_abc123"
}
idstring
معرّف لاستخدامه في الطلبات اللاحقة والدعم.
statusstring
الحالة الحالية للدفعة. لا تعني استجابة الإلغاء الناجحة أن الحالة المعادة هي دائمًا cancelling.

التفويض

BearerAuth
AuthorizationBearer <token>

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

الموضع: header

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

batch_id*string

الاستجابة

application/json

application/json