Claude Platform Docs

Listar lotes de mensajes

messages.batches.list(**kwargs) -> SyncPage[MessageBatch]
GET/v1/messages/batches

Lista todos los lotes de mensajes dentro de un Workspace. Los lotes creados más recientemente se devuelven primero.

Obtén más información sobre la API de Message Batches en nuestra guía de usuario

Parameters
after_id: Optional[str]⁠Query parameter

ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.

before_id: Optional[str]⁠Query parameter

ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.

limit: Optional[int]⁠Query parameter

Number of items to return per page.

Defaults to 20. Ranges from 1 to 1000.

default20
minimum1
maximum1000
workspace_id: Optional[str]⁠Header parameter

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 MessageBatch: type: "message_batch"; id; archived_at; ... # 7 more
Listar lotes de mensajes
import os
from anthropic import Anthropic

client = Anthropic(
    api_key=os.environ.get(
        "ANTHROPIC_API_KEY"
    ),  # This is the default and can be omitted
)
page = client.messages.batches.list()
page = page.data[0]
print(page.id)
Returns Examples
Response 200
{
  "data": [
    {
      "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
      "archived_at": "2024-08-20T18:37:24.100435Z",
      "cancel_initiated_at": "2024-08-20T18:37:24.100435Z",
      "created_at": "2024-08-20T18:37:24.100435Z",
      "ended_at": "2024-08-20T18:37:24.100435Z",
      "expires_at": "2024-08-20T18:37:24.100435Z",
      "processing_status": "in_progress",
      "request_counts": {
        "canceled": 10,
        "errored": 30,
        "expired": 10,
        "processing": 100,
        "succeeded": 50
      },
      "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results",
      "type": "message_batch"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}