Skip to main content
POST
创建消息批处理
要使用此处展示的 Beta 请求和响应结构,请同时发送 ?beta=trueanthropic-beta: message-batches-2024-09-24

授权

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

OMA 工作区 API 密钥。

请求头

anthropic-beta
string
必填

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

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

anthropic-version
string

你想使用的 OMA API 版本。

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

anthropic-user-profile-id
string

用于归属此批次中请求的用户资料 ID。在代表你的组织以外的当事方行事时使用。需要 user-profiles beta 请求头。适用于批次中的每个请求;若单个请求的 user_profile_id 正文字段与此请求头冲突,该请求将返回错误。

查询参数

beta
enum<boolean>
必填

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

可用选项:
true

请求体

application/json
requests
MessageBatchIndividualRequestParams · object[]
必填

提示补全请求列表。每一项都是创建一条消息的独立请求。

Required array length: 1 - 100000 elements

响应

成功的响应

archived_at
string<date-time> | null
必填

表示消息批处理被归档且其结果不再可用的时间的 RFC 3339 日期时间字符串。

示例:

"2024-08-20T18:37:24.100435Z"

cancel_initiated_at
string<date-time> | null
必填

表示发起取消该消息批处理的时间的 RFC 3339 日期时间字符串。仅在已发起取消时才会指定。

示例:

"2024-08-20T18:37:24.100435Z"

created_at
string<date-time>
必填

表示消息批处理创建时间的 RFC 3339 日期时间字符串。

示例:

"2024-08-20T18:37:24.100435Z"

ended_at
string<date-time> | null
必填

表示消息批处理处理结束时间的 RFC 3339 日期时间字符串。仅在处理结束时指定。

当消息批处理中的每个请求都已成功、出错、取消或过期时,处理结束。

示例:

"2024-08-20T18:37:24.100435Z"

expires_at
string<date-time>
必填

表示消息批处理将到期并结束处理的时间的 RFC 3339 日期时间字符串,即创建后 24 小时。

示例:

"2024-08-20T18:37:24.100435Z"

id
string
必填

唯一的对象标识符。

ID 的格式和长度可能会随时间变化。

示例:

"msgbatch_013Zva2CMHLNnXjNJJKqJ2EF"

processing_status
enum<string>
必填

消息批处理的处理状态。

可用选项:
in_progress,
canceling,
ended
示例:

"in_progress"

request_counts
RequestCounts · object
必填

按状态分类统计消息批处理中的请求。

请求初始状态为 processing,仅在整个批次的处理结束后才会转为其他状态之一。所有值之和始终与批次中的请求总数一致。

results_url
string | null
必填

包含消息批处理请求结果的 .jsonl 文件的 URL。仅在处理结束时指定。

不保证文件中的结果与请求的顺序一致。请使用 custom_id 字段将结果与请求匹配。

示例:

"https://oma.example.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results"

type
string
默认值:message_batch
必填

对象类型。

对于消息批处理,此值始终为 "message_batch"

Allowed value: "message_batch"