Claude Platform Docs

メッセージバッチを削除

DeletedMessageBatch Messages.Batches.Delete(parameters, cancellationToken = default)
DELETE/v1/messages/batches/{message_batch_id}

メッセージバッチを削除します。

メッセージバッチは処理が完了した後にのみ削除できます。進行中のバッチを削除したい場合は、まずキャンセルする必要があります。

Message Batches APIの詳細については、ユーザーガイドをご覧ください。

Parameters
BatchDeleteParams parameters
required string messageBatchID

ID of the Message Batch.

string workspaceID

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; }
JsonElement Type = "message_batch_deleted"

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

required string ID

ID of the Message Batch.

メッセージバッチを削除
BatchDeleteParams parameters = new() { MessageBatchID = "message_batch_id" };

var deletedMessageBatch = await client.Messages.Batches.Delete(parameters);

Console.WriteLine(deletedMessageBatch);
Returns Examples
Response 200
{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch_deleted"
}