Dateien & Batch-Jobs

Message Batch abbrechen

Bricht einen Message Batch ab, der noch verarbeitet wird.

POST
/v1/messages/batches/{message_batch_id}/cancel

Überblick

Fordern Sie den Abbruch eines Message Batch an, der noch verarbeitet wird. Die Antwort zeigt den aktuellen Status. processing_status ist in der Regel canceling, und Anfragen, die bereits ausgeführt werden, können dennoch abgeschlossen werden. Ein Batch, der bereits beendet wurde, wird unverändert zurückgegeben.

Hinweise

  • Rufen Sie nach dem Abbruch den Batch so lange ab, bis processing_status den Wert ended aufweist. Anfragen, die noch nicht gestartet wurden, enden mit dem Status canceled.
  • Ein Batch, der nicht existiert oder gelöscht wurde, gibt 404 zurück. Ein Batch, der noch nicht für Änderungen bereit ist, gibt 409 zurück; versuchen Sie es später erneut.
  • Der Abbruch löscht den Batch nicht. Um ihn zu entfernen, löschen Sie ihn, nachdem er beendet wurde.

Beispiel

Anfrage

cURL
curl -X POST "https://api.tokenlab.sh/v1/messages/batches/msgbatch_01ABC123/cancel" \
  -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": "canceling",
  "request_counts": {
    "processing": 1,
    "succeeded": 1,
    "errored": 0,
    "canceled": 0,
    "expired": 0
  },
  "ended_at": null,
  "created_at": "2026-11-01T10:00:00Z",
  "expires_at": "2026-11-02T10:00:00Z",
  "cancel_initiated_at": "2026-11-01T10:05:00Z",
  "archived_at": null,
  "results_url": null
}

Wichtige Felder

processing_statusstring
canceling während der Abbruch läuft, ended sobald er abgeschlossen ist. Gehen Sie nicht davon aus, dass jede Abbruchanfrage canceling zurückgibt.
cancel_initiated_atstring|null
Zeitpunkt, zu dem die Abbruchanfrage akzeptiert wurde, 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