跳转到主要内容
GET
获取批处理任务详情
获取指定批处理任务的当前状态、进度统计和详细元数据。通常用于创建任务后轮询任务是否完成。
完整的调用示例和轮询脚本请参考 Batch API 指南
statuscompleted 时,output_file_id 包含结果文件 ID;当 statusfailed 时,建议查看 error_file_id 获取错误详情。如果指定的 batch_id 不存在,接口将返回 404 错误(resource_not_found_error)。

授权

Authorization
string
header
必填

Authorization 请求头需要一个 Bearer 令牌。使用 MOONSHOT_API_KEY 作为令牌。这是一个服务端密钥,请在 API 密钥页面 生成。

路径参数

batch_id
string
必填

批处理任务的 ID

响应

批处理任务详情

id
string
必填

批处理任务的唯一标识符

object
string
必填

对象类型,固定为 batch

示例:

"batch"

endpoint
string
必填

请求端点

input_file_id
string
必填

输入文件 ID

completion_window
string
必填

任务处理时间窗口

status
enum<string>
必填

当前状态:validating(校验中)、failed(校验失败)、in_progress(执行中)、finalizing(准备结果中)、completed(已完成)、expired(已过期)、cancelling(取消中)、cancelled(已取消)

可用选项:
validating,
failed,
in_progress,
finalizing,
completed,
expired,
cancelling,
cancelled
created_at
integer
必填

创建时间(Unix 时间戳)

request_counts
object
必填
output_file_id
string | null

处理成功的结果文件 ID

error_file_id
string | null

处理失败的错误文件 ID

in_progress_at
integer | null

开始执行时间(Unix 时间戳)

expires_at
integer | null

过期时间(Unix 时间戳)

finalizing_at
integer | null

开始准备结果的时间(Unix 时间戳)

completed_at
integer | null

完成时间(Unix 时间戳)

failed_at
integer | null

校验失败时间(Unix 时间戳)

cancelling_at
integer | null

发起取消时间(Unix 时间戳)

cancelled_at
integer | null

取消完成时间(Unix 时间戳)

metadata
object | null

自定义元数据