Claude Platform Docs

List Message Batches

client.Messages.Batches.List(ctx, params) (*Page[MessageBatch], error)
GET/v1/messages/batches

List all Message Batches within a Workspace. Most recently created batches are returned first.

Learn more about the Message Batches API in our user guide

Parameters
params MessageBatchListParams
AfterID param.Field[string] Optional

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

BeforeID param.Field[string] Optional

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

Limit param.Field[int64] Optional

Query param: Number of items to return per page.

Defaults to 20. Ranges from 1 to 1000.

maximum1000
minimum1
WorkspaceID param.Field[string] Optional

Header param: 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
type MessageBatch struct { Type: "message_batch"; ID; ArchivedAt; /* 7 more */ }
List Message Batches
package main

import (
	"context"
	"fmt"

	"github.com/anthropics/anthropic-sdk-go"
	"github.com/anthropics/anthropic-sdk-go/option"
)

func main() {
	client := anthropic.NewClient(
		option.WithAPIKey("my-anthropic-api-key"),
	)
	page, err := client.Messages.Batches.List(context.TODO(), anthropic.MessageBatchListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", 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"
}