Eliminar un lote de mensajes

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

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

Parameters

messageBatchID: string

ID of the Message Batch.

workspaceID?:optional string

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.

Eliminar un lote de mensajes

<?php

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

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