跳转到主要内容
POST
/
v1
/
batches
创建批处理任务
curl --request POST \
  --url https://api.moonshot.cn/v1/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input_file_id": "<string>",
  "endpoint": "/v1/chat/completions",
  "completion_window": "<string>"
}
'
{
  "id": "<string>",
  "object": "batch",
  "endpoint": "<string>",
  "input_file_id": "<string>",
  "completion_window": "<string>",
  "status": "validating",
  "created_at": 123,
  "request_counts": {
    "completed": 123,
    "failed": 123,
    "total": 123
  },
  "output_file_id": "<string>",
  "error_file_id": "<string>",
  "in_progress_at": 123,
  "expires_at": 123,
  "finalizing_at": 123,
  "completed_at": 123,
  "failed_at": 123,
  "cancelling_at": 123,
  "cancelled_at": 123,
  "metadata": {}
}
限制:
限制项说明
文件格式必须为 .jsonl 扩展名
文件大小不能为空,最大 100MB
组织文件配额每个组织最多 1000 个 batch 类型文件
模型一致性同一批次内所有请求必须使用相同模型
custom_id文件内必须唯一
模型权限指定的模型必须存在且用户有访问权限
完整的调用示例请参考 Batch API 指南

授权

Authorization
string
header
必填

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

请求体

application/json
input_file_id
string
必填

输入文件的 ID,必须是通过 purpose="batch" 上传的 .jsonl 文件

endpoint
enum<string>
必填

请求端点,目前仅支持 /v1/chat/completions

可用选项:
/v1/chat/completions
completion_window
string
必填

任务处理的时间窗口,支持语义化格式如 12h、1d、3d,最小 12h,最大 7d

metadata
object

自定义元数据,最多 16 个键值对,key 最长 64 字符,value 最长 512 字符

响应

已创建的批处理任务

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

自定义元数据