Einen Message Batch löschen

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

DELETE/v1/messages/batches/{message_batch_id}

Lösche einen Message Batch.

Message Batches können erst gelöscht werden, wenn ihre Verarbeitung abgeschlossen ist. Wenn du einen laufenden Batch löschen möchtest, musst du ihn zuerst abbrechen.

Mehr über die Message Batches API erfährst du in unserem Benutzerhandbuch

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.

Einen Message Batch löschen

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