Claude Platform Docs

刪除訊息批次

DELETE/v1/messages/batches/{message_batch_id}

刪除訊息批次。

訊息批次僅能在處理完成後刪除。若您想刪除進行中的批次,必須先將其取消。

在我們的使用者指南中進一步瞭解 Message Batches API

Path parameters
message_batch_id: string

ID of the Message Batch.

Headers
"anthropic-workspace-id": optional string

Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

Returns
DeletedMessageBatch object{ type: "message_batch_deleted", id }
type: "message_batch_deleted"

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

defaultmessage_batch_deleted
id: string

ID of the Message Batch.

刪除訊息批次
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"
Returns Examples
Response 200
{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch_deleted"
}