Claude Platform Docs

Retrieve Message Batch results

client.Messages.Batches.ResultsStreaming(ctx, messageBatchID, query) *jsonl.Stream[MessageBatchIndividualResponse]
GET/v1/messages/batches/{message_batch_id}/results

Streams the results of a Message Batch as a .jsonl file.

Each line in the file is a JSON object containing the result of a single request in the Message Batch. Results are not guaranteed to be in the same order as requests. Use the custom_id field to match results to requests.

Learn more about the Message Batches API in our user guide

Parameters
messageBatchID string⁠Path parameter

ID of the Message Batch.

query MessageBatchResultsParams
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 MessageBatchIndividualResponse struct { CustomID; Result }

This is a single line in the response .jsonl file and does not represent the response as a whole.

CustomID string

Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order.

Must be unique for each request within the Message Batch.

Processing result for this request.

Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration.

One of the following:
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.

ErrorCodeCMEKKeyDisabledHTTP status 400error code cmek_key_disabled

The workspace's customer-managed encryption key is disabled or revoked. Re-enable the key, then retry.

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 Message Batch results
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"),
	)
	stream := client.Messages.Batches.ResultsStreaming(
		context.TODO(),
		"message_batch_id",
		anthropic.MessageBatchResultsParams{},
	)
	for stream.Next() {
		fmt.Printf("%+v\n", stream.Current())
	}
	err := stream.Err()
	if err != nil {
		panic(err.Error())
	}
}