Supprimer un lot de messages

DELETE/v1/messages/batches/{message_batch_id}

Supprimer un lot de messages.

Les lots de messages ne peuvent être supprimés qu'une fois leur traitement terminé. Si vous souhaitez supprimer un lot en cours de traitement, vous devez d'abord l'annuler.

Pour en savoir plus sur l'API Message Batches, consultez notre guide de l'utilisateur.

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.

Supprimer un lot de messages

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"
}