Dateien & Batch-Jobs

Batch abbrechen

Einen Batch abbrechen, der noch nicht abgeschlossen ist.

POST
/v1/batches/{batch_id}/cancel

Fordern Sie den Abbruch eines in der Warteschlange befindlichen oder laufenden Batches an. Die Antwort enthält seinen aktuellen Status: Der Abbruch kann noch im Gange oder bereits abgeschlossen sein. Ein Batch, der bereits beendet ist, behält seinen bestehenden terminalen Status. Wenn der zurückgegebene Status nicht terminal ist, rufen Sie den Batch erneut ab, um das Ergebnis zu prüfen. Eine unbekannte Batch-ID gibt 404 batch_not_found zurück.

Anfrage

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

Antwort

200 OK
{
  "id": "batch_abc123",
  "object": "batch",
  "status": "cancelling",
  "input_file_id": "file_abc123"
}
idstring
Batch-ID.
statusstring
Aktueller Batch-Status. Gehen Sie nicht davon aus, dass jede erfolgreiche Abbruchanfrage cancelling zurückgibt.

Autorisierung

BearerAuth
AuthorizationBearer <token>

API-Key-Authentifizierung. Erstellen oder verwalten Sie API-Keys unter Dashboard > API > API Keys.

Ort: header

Pfadparameter

batch_id*string

Antwort

application/json

application/json

application/json