Die Message Batches API unterstützt die gleichen Funktionen wie die Messages API. Während sich diese Seite darauf konzentriert, wie man die Message Batches API verwendet, finden Sie unter Messages API Beispiele Beispiele für den Funktionsumfang der Messages API.

Einen Nachrichtenbatch erstellen

JSON
{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch",
  "processing_status": "in_progress",
  "request_counts": {
    "processing": 2,
    "succeeded": 0,
    "errored": 0,
    "canceled": 0,
    "expired": 0
  },
  "ended_at": null,
  "created_at": "2024-09-24T18:37:24.100435Z",
  "expires_at": "2024-09-25T18:37:24.100435Z",
  "cancel_initiated_at": null,
  "results_url": null
}

Abfragen des Nachrichtenbatch-Abschlusses

Um einen Nachrichtenbatch abzufragen, benötigen Sie seine id, die in der Antwort beim Erstellen oder beim Auflisten von Batches bereitgestellt wird. Beispiel id: msgbatch_013Zva2CMHLNnXjNJJKqJ2EF.

Alle Nachrichtenbatches in einem Workspace auflisten

Output
{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch",
  ...
}
{
  "id": "msgbatch_01HkcTjaV5uDC8jWR4ZsDV8d",
  "type": "message_batch",
  ...
}

Nachrichtenbatch-Ergebnisse abrufen

Sobald der Status Ihres Nachrichtenbatches ended ist, können Sie die results_url des Batches sehen und die Ergebnisse in Form einer .jsonl-Datei abrufen.

Output
{
  "id": "my-second-request",
  "result": {
    "type": "succeeded",
    "message": {
      "id": "msg_018gCsTGsXkYJVqYPxTgDHBU",
      "type": "message",
      ...
    }
  }
}
{
  "custom_id": "my-first-request",
  "result": {
    "type": "succeeded",
    "message": {
      "id": "msg_01XFDUDYJgAACzvnptvVoYEL",
      "type": "message",
      ...
    }
  }
}

Einen Nachrichtenbatch abbrechen

Unmittelbar nach dem Abbruch wird der processing_status eines Batches auf canceling gesetzt. Sie können die gleiche Technik zum Abfragen des Batch-Abschlusses verwenden, um zu überprüfen, wann der Abbruch abgeschlossen ist, da abgebrochene Batches ebenfalls den Status ended erreichen und möglicherweise Ergebnisse enthalten können.

JSON
{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch",
  "processing_status": "canceling",
  "request_counts": {
    "processing": 2,
    "succeeded": 0,
    "errored": 0,
    "canceled": 0,
    "expired": 0
  },
  "ended_at": null,
  "created_at": "2024-09-24T18:37:24.100435Z",
  "expires_at": "2024-09-25T18:37:24.100435Z",
  "cancel_initiated_at": "2024-09-24T18:39:03.114875Z",
  "results_url": null
}