Dateien & Batch-Jobs

Batch abrufen

Ruft den aktuellen Status, die Anzahl der Anfragen und die Ergebnisdateien für einen Batch ab.

GET
/v1/batches/{batch_id}

Überblick

Gibt den Batch-Status, die Anzahl der Anfragen und die IDs der Ergebnisdateien zurück. Eine unbekannte Batch-ID oder ein Batch aus einem anderen Workspace führt zu 404 batch_not_found.

status ist einer der folgenden Werte: validating, queued, in_progress, finalizing, completed, failed, cancelling, cancelled oder expired. Die Ergebnisdateien sind verfügbar, wenn der status completed lautet; lesen Sie diese mit Dateiinhalt abrufen.

Beispiel

Anfrage

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

Antwortbeispiel

Antwort

200 OK
{
  "id": "batch_abc123",
  "object": "batch",
  "status": "completed",
  "input_file_id": "file_abc123",
  "output_file_id": "file_out123",
  "error_file_id": "file_err123",
  "request_counts": { "total": 100, "completed": 98, "failed": 2 }
}

Wichtige Felder

request_countsobject
Anzahl der gesamten, abgeschlossenen, fehlgeschlagenen und abgebrochenen Anfragen.
output_file_idstring|null
ID der Datei mit den erfolgreichen Ergebnissen.
error_file_idstring|null
ID der Datei mit den fehlgeschlagenen Ergebnissen.

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