訊息批次 API 支援與訊息 API 相同的功能集。雖然本頁面著重於如何使用訊息批次 API，但有關訊息 API 功能集的範例，請參閱訊息 API 範例。

​
建立訊息批次

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
}

​
輪詢訊息批次完成狀態

要輪詢訊息批次，您需要其 id，這可以在建立請求的回應中或透過列出批次獲得。範例 id：msgbatch_013Zva2CMHLNnXjNJJKqJ2EF。

​
列出工作區中的所有訊息批次

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

​
獲取訊息批次結果

一旦您的訊息批次狀態為 ended，您就可以查看批次的 results_url 並以 .jsonl 檔案形式獲取結果。

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",
      ...
    }
  }
}

​
取消訊息批次

取消後，批次的 processing_status 將立即變為 canceling。您可以使用相同的輪詢批次完成技術來輪詢取消何時完成，因為被取消的批次最終也會變為 ended 狀態，並可能包含結果。

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
}
取消訊息批次（測試版）Create a Text Completion