Supprimer un lot de messages

$client->messages->batches->delete(string messageBatchID, ?string workspaceID): DeletedMessageBatch

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.

Parameters

messageBatchID: string⁠Path

ID of the Message Batch.

workspaceID?: 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

class DeletedMessageBatch { $type = 'message_batch_deleted'; $id; }

"message_batch_deleted" type

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

string id

ID of the Message Batch.

Supprimer un lot de messages

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Anthropic\Client;

$client = new Client(apiKey: 'my-anthropic-api-key');

$deletedMessageBatch = $client->messages->batches->delete(
  'message_batch_id', workspaceID: 'wrkspc_011CZkZaBF1tNoB5wlCeusgy'
);

var_dump($deletedMessageBatch);

Response 200

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

Returns Examples

Response 200

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