删除消息批次

$ ant messages:batches delete

DELETE/v1/messages/batches/{message_batch_id}

删除消息批次。

消息批次只有在处理完成后才能删除。如果您想删除正在处理中的批次，必须先将其取消。

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

Parameters

--message-batch-id: string⁠Path

ID of the Message Batch.

--workspace-id: optional string⁠Header

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

deleted_message_batch: object{ type: "message_batch_deleted", id }

type: "message_batch_deleted"

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

id: string

ID of the Message Batch.

删除消息批次

ant messages:batches delete \
  --api-key my-anthropic-api-key \
  --message-batch-id message_batch_id

Response 200

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

Returns Examples

Response 200

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