Dateien & Batch-Jobs

Nachrichten-Batch abrufen

Ruft den Status und die Anforderungsanzahl eines Nachrichten-Batch ab.

GET
/v1/messages/batches/{message_batch_id}

Überblick

Gibt den Status, die Anforderungsanzahl und die Zeitstempel eines Nachrichten-Batch zurück, das von Ihrer Organisation erstellt wurde. Fragen Sie diesen Endpunkt ab, bis processing_status den Wert ended hat, und rufen Sie dann die Ergebnisse ab.

Hinweise

  • processing_status ist entweder in_progress, canceling oder ended.
  • results_url ist null, bis das Batch beendet wurde.
  • Ein Batch, das nicht existiert oder gelöscht wurde, gibt 404 zurück. Ein Batch, das noch nicht zum Lesen bereit ist, kann 409 zurückgeben; versuchen Sie es später erneut.

Beispiel

Anfrage

cURL
curl -X GET "https://api.tokenlab.sh/v1/messages/batches/msgbatch_01ABC123" \
  -H "x-api-key: sk-your-api-key" \
  -H "anthropic-version: 2023-06-01"

Antwortbeispiel

Antwort

200 OK
{
  "id": "msgbatch_01ABC123",
  "type": "message_batch",
  "processing_status": "ended",
  "request_counts": {
    "processing": 0,
    "succeeded": 2,
    "errored": 0,
    "canceled": 0,
    "expired": 0
  },
  "ended_at": "2026-11-01T10:20:00Z",
  "created_at": "2026-11-01T10:00:00Z",
  "expires_at": "2026-11-02T10:00:00Z",
  "cancel_initiated_at": null,
  "archived_at": null,
  "results_url": "https://api.tokenlab.sh/v1/messages/batches/msgbatch_01ABC123/results"
}

Wichtige Felder

processing_statusstring
in_progress, canceling oder ended.
request_countsobject
Anzahl der Anforderungen, die processing, succeeded, errored, canceled oder expired sind.
ended_atstring|null
Zeitpunkt, zu dem die Verarbeitung endete, oder null.
cancel_initiated_atstring|null
Zeitpunkt, zu dem eine Abbruchanforderung akzeptiert wurde, oder null.
results_urlstring|null
URL der Ergebnisse, oder null.

Autorisierung

BearerAuth
AuthorizationBearer <token>

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

Ort: header

Pfadparameter

message_batch_id*string

Bezeichner des Nachrichten-Batch

Antwort

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json