检索消息批处理结果

通过 OMA API 检索消息批处理结果。

GET /v1/messages/batches/{message_batch_id}/results

检索消息批处理结果

cURL

curl --request GET \
  --url http://localhost:38080/v1/messages/batches/{message_batch_id}/results \
  --header 'X-Api-Key: <api-key>' \
  --header 'anthropic-beta: <anthropic-beta>'

200

{
  "custom_id": "my-custom-id-1",
  "result": {
    "message": {
      "content": [
        {
          "citations": null,
          "text": "你好！我是你的智能助手。",
          "type": "text"
        }
      ],
      "id": "msg_013Zva2CMHLNnXjNJJKqJ2EF",
      "model": "claude-opus-4-6",
      "role": "assistant",
      "stop_details": null,
      "stop_reason": "end_turn",
      "stop_sequence": null,
      "type": "message",
      "usage": {
        "input_tokens": 2095,
        "output_tokens": 503
      }
    },
    "type": "succeeded"
  }
}

要使用此处展示的 Beta 请求和响应结构，请同时发送 ?beta=true 与 anthropic-beta: message-batches-2024-09-24。

授权

omaApiKeyomaBearer

X-Api-Key · string · header · 默认值: sk-ant-local-default · 必填

OMA 工作区 API 密钥。

请求头

anthropic-beta · string · 必填

用于指定要使用的 beta 版本的可选请求头。

要使用多个 beta，请使用逗号分隔的列表（如 beta1,beta2），或为每个 beta 分别指定该请求头。

anthropic-version · string

你想使用的 OMA API 版本。

在此处阅读更多关于版本控制和我们版本历史的信息。

路径参数

message_batch_id · string · 必填

消息批处理的 ID。

查询参数

beta · enum<boolean> · 必填

为此接口启用 Beta API 合同，必须为 true。

可用选项: true

响应

200

application/x-jsonl

成功的响应

这是响应 .jsonl 文件中的一行，不代表整个响应。

custom_id · string · 必填

为消息批处理中的每个请求创建的开发者提供的 ID。由于结果可能不按请求顺序给出，可用于将结果与请求匹配。

在消息批处理内必须对每个请求唯一。

示例:

"my-custom-id-1"

result · SucceededResult · object · 必填

该请求的处理结果。

如果处理成功，包含消息输出；如果处理失败，包含错误响应；如果未尝试处理，则包含原因，例如已取消或已过期。

SucceededResult

ErroredResult

CanceledResult

ExpiredResult

Show child attributes