メッセージバッチを削除

messages.batches.delete(message_batch_id, **kwargs) -> DeletedMessageBatch

DELETE/v1/messages/batches/{message_batch_id}

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

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

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

Parameters

message_batch_id: String⁠Path

ID of the Message Batch.

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

class DeletedMessageBatch { type: :message_batch_deleted, id }

type: :message_batch_deleted

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

id: String

ID of the Message Batch.

メッセージバッチを削除

require "anthropic"

anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")

deleted_message_batch = anthropic.messages.batches.delete("message_batch_id")

puts(deleted_message_batch)

Response 200

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

Returns Examples

Response 200

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