Eliminar un lote de mensajes

DELETE/v1/messages/batches/{message_batch_id}

Elimina un lote de mensajes.

Los lotes de mensajes solo pueden eliminarse una vez que han terminado de procesarse. Si deseas eliminar un lote en curso, primero debes cancelarlo.

Obtén más información sobre la API de Message Batches en nuestra guía de usuario

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.

Eliminar un lote de mensajes

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"

Response 200

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

Returns Examples

Response 200

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