删除消息批处理

delete /v1/messages/batches/{message_batch_id}

删除消息批处理。

消息批处理只能在完成处理后删除。如果您想删除正在处理的批处理，必须先取消它。

在我们的用户指南中了解更多关于 Message Batches API 的信息

路径参数

• message_batch_id: string

  消息批处理的 ID。

返回值

• DeletedMessageBatch object { id, type }

  • id: string

    消息批处理的 ID。

  • type: "message_batch_deleted"

    已删除对象类型。

    对于消息批处理，始终为 "message_batch_deleted"。

    • "message_batch_deleted"

示例

curl https://api.anthropic.com/v1/messages/batches/$MESSAGE_BATCH_ID \
    -X DELETE \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

响应

{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch_deleted"
}