Claude Platform Docs

Retrieve a Message Batch

client.Messages.Batches.Get(ctx, messageBatchID, query) (*MessageBatch, error)
GET/v1/messages/batches/{message_batch_id}

This endpoint is idempotent and can be used to poll for Message Batch completion. To access the results of a Message Batch, make a request to the results_url field in the response.

Learn more about the Message Batches API in our user guide

Parameters
messageBatchID string⁠Path parameter

ID of the Message Batch.

query MessageBatchGetParams
WorkspaceID param.Opt[string] OptionalHeader 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
type MessageBatch struct { Type: "message_batch"; ID; ArchivedAt; /* 7 more */ }
Errors

Any method can also return the general HTTP errors.

ErrorCodeClaudeCodeKeyCreatorNotMemberHTTP status 400error code claude_code_key_creator_not_member

The API key belongs to the Claude Code workspace, and the user who created it is no longer a member of the organization or of that workspace.

ErrorCodeOrganizationOnHoldHTTP status 400error code organization_on_hold

Anthropic has disabled the organization for trust and safety reasons. An organization disabled for any other reason, such as billing, does not get this code. appeal_url, when present, is where the organization can appeal.

Retrieve a Message Batch
package main

import (
	"context"
	"fmt"

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

func main() {
	client := anthropic.NewClient(
		option.WithAPIKey("my-anthropic-api-key"),
	)
	messageBatch, err := client.Messages.Batches.Get(
		context.TODO(),
		"message_batch_id",
		anthropic.MessageBatchGetParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", messageBatch.ID)
}
Returns Examples
Response 200
{
  "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"
}