Dosyalar ve toplu işler

Batch İptal Et

Sıralı veya çalışan bir batch işini iptal eder.

POST
/v1/batches/{batch_id}/cancel

Kuyrukta veya çalışmakta olan bir batch için iptal isteyin. Yanıt geçerli durumu içerir: iptal sürüyor veya tamamlanmış olabilir. Daha önce sona ermiş bir batch mevcut son durumunu korur. Döndürülen durum son durum değilse sonucu kontrol etmek için batch’i yeniden alın.

İ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
Sonraki çağrılar ve support için kullanılan identifier.
statusstring
Geçerli batch durumu. Başarılı bir iptal isteği her zaman cancelling döndürmez.

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