Dateien & Batch-Jobs

Batch abbrechen

Bricht einen wartenden oder laufenden Batch-Job ab.

POST
/v1/batches/{batch_id}/cancel

Fordern Sie den Abbruch eines wartenden oder laufenden Batches an. Die Antwort enthält den aktuellen Status: Der Abbruch kann noch laufen oder bereits abgeschlossen sein. Ein bereits beendeter Batch behält seinen bisherigen Endstatus. Rufen Sie den Batch erneut ab, wenn der zurückgegebene Status noch nicht endgültig ist.

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
Kennung für Folgeaufrufe und Support.
statusstring
Aktueller Batch-Status. Eine erfolgreiche Abbruchanfrage gibt nicht immer cancelling zurück.

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