Dosyalar ve toplu işler

Batch'i İptal Et

Henüz tamamlanmamış bir batch'i iptal edin.

POST
/v1/batches/{batch_id}/cancel

Kuyrukta bekleyen veya çalışan bir batch'in iptal edilmesini talep edin. Yanıt, batch'in güncel durumunu içerir: iptal işlemi hâlâ devam ediyor olabilir veya çoktan tamamlanmış olabilir. Zaten tamamlanmış olan bir batch, mevcut nihai durumunu korur. Döndürülen durum nihai değilse, sonucu kontrol etmek için batch'i tekrar alın. Bilinmeyen bir batch ID'si 404 batch_not_found döndürür.

İstek

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

Yanıt

200 OK
{
  "id": "batch_abc123",
  "object": "batch",
  "status": "cancelling",
  "input_file_id": "file_abc123"
}
idstring
Batch ID'si.
statusstring
Güncel batch durumu. Her başarılı iptal talebinin cancelling döndüreceğini varsaymayın.

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

batch_id*string

Yanıt

application/json

application/json

application/json