English ← MyDocs

删除消息批处理

delete /v1/messages/batches/{message_batch_id}

删除消息批处理。

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

在我们的用户指南中了解更多关于消息批处理 API 的信息

路径参数

  • message_batch_id: string

    消息批处理的 ID。

请求头参数

  • "anthropic-beta": optional array of AnthropicBeta

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

    • string

    • "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 22 more

      • "message-batches-2024-09-24"

      • "prompt-caching-2024-07-31"

      • "computer-use-2024-10-22"

      • "computer-use-2025-01-24"

      • "pdfs-2024-09-25"

      • "token-counting-2024-11-01"

      • "token-efficient-tools-2025-02-19"

      • "output-128k-2025-02-19"

      • "files-api-2025-04-14"

      • "mcp-client-2025-04-04"

      • "mcp-client-2025-11-20"

      • "dev-full-thinking-2025-05-14"

      • "interleaved-thinking-2025-05-14"

      • "code-execution-2025-05-22"

      • "extended-cache-ttl-2025-04-11"

      • "context-1m-2025-08-07"

      • "context-management-2025-06-27"

      • "model-context-window-exceeded-2025-08-26"

      • "skills-2025-10-02"

      • "fast-mode-2026-02-01"

      • "output-300k-2026-03-24"

      • "user-profiles-2026-03-24"

      • "advisor-tool-2026-03-01"

      • "managed-agents-2026-04-01"

      • "cache-diagnosis-2026-04-07"

返回

  • BetaDeletedMessageBatch 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 'anthropic-beta: message-batches-2024-09-24' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

响应

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