Einen Message Batch löschen

client.messages.batches.delete(messageBatchID, params?, options?): 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⁠Path

ID of the Message Batch.

params: BatchDeleteParams { workspace_id }

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

interface DeletedMessageBatch { type: "message_batch_deleted"; id }

type: "message_batch_deleted"

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

defaultmessage_batch_deleted

id: string

ID of the Message Batch.

Einen Message Batch löschen

import Anthropic from "@anthropic-ai/sdk";

const client = new Anthropic({
  apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted
});

const deletedMessageBatch = await client.messages.batches.delete("message_batch_id");

console.log(deletedMessageBatch.id);

Response 200

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

Returns Examples

Response 200

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