Claude Platform Docs

Lister les lots de messages

messages.batches.list(**kwargs) -> Page<MessageBatch>
GET/v1/messages/batches

Lister tous les lots de messages d'un espace de travail. Les lots créés le plus récemment sont renvoyés en premier.

Pour en savoir plus sur l'API Message Batches, consultez notre guide de l'utilisateur.

Parameters
after_id: String⁠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: String⁠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: Integer⁠Query parameter

Number of items to return per page.

Defaults to 20. Ranges from 1 to 1000.

minimum1
maximum1000
workspace_id: String⁠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 }
Lister les lots de messages
require "anthropic"

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

page = anthropic.messages.batches.list

puts(page)
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"
}