Elimina un batch di messaggi

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

DELETE/v1/messages/batches/{message_batch_id}

Elimina un batch di messaggi.

I batch di messaggi possono essere eliminati solo dopo che hanno terminato l'elaborazione. Se desideri eliminare un batch in corso, devi prima annullarlo.

Scopri di più sull'API Message Batches nella nostra guida per l'utente

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.

Elimina un batch di messaggi

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