Удалить пакет сообщений

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

DELETE/v1/messages/batches/{message_batch_id}

Удалите пакет сообщений.

Пакеты сообщений можно удалять только после завершения их обработки. Если вы хотите удалить пакет, находящийся в обработке, сначала необходимо его отменить.

Подробнее о Message Batches API читайте в нашем руководстве пользователя

Parameters

message_batch_id: str⁠Path

ID of the Message Batch.

workspace_id: Optional[str]⁠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: Literal["message_batch_deleted"]

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

defaultmessage_batch_deleted

id: str

ID of the Message Batch.

Удалить пакет сообщений

import os
from anthropic import Anthropic

client = Anthropic(
    api_key=os.environ.get(
        "ANTHROPIC_API_KEY"
    ),  # This is the default and can be omitted
)
deleted_message_batch = client.messages.batches.delete(
    message_batch_id="message_batch_id",
)
print(deleted_message_batch.id)

Response 200

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

Returns Examples

Response 200

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