Retrieve Message Batch results

Retrieve Message Batch results through the OMA API.

GET /v1/messages/batches/{message_batch_id}/results

Retrieve Message Batch results

cURL

curl --request GET \
  --url http://localhost:38080/v1/messages/batches/{message_batch_id}/results \
  --header 'X-Api-Key: <api-key>' \
  --header 'anthropic-beta: <anthropic-beta>'

200

{
  "custom_id": "my-custom-id-1",
  "result": {
    "message": {
      "content": [
        {
          "citations": null,
          "text": "Hi! I am your AI assistant.",
          "type": "text"
        }
      ],
      "id": "msg_013Zva2CMHLNnXjNJJKqJ2EF",
      "model": "claude-opus-4-6",
      "role": "assistant",
      "stop_details": null,
      "stop_reason": "end_turn",
      "stop_sequence": null,
      "type": "message",
      "usage": {
        "input_tokens": 2095,
        "output_tokens": 503
      }
    },
    "type": "succeeded"
  }
}

Use ?beta=true with anthropic-beta: message-batches-2024-09-24 for the beta request and response shapes shown here.

Authorizations

omaApiKeyomaBearer

X-Api-Key · string · header · default: sk-ant-local-default · required

OMA workspace API key.

Headers

anthropic-beta · string · required

Optional header to specify the beta version(s) you want to use.

To use multiple betas, use a comma separated list like beta1,beta2 or specify the header multiple times for each beta.

anthropic-version · string

The version of the OMA API you want to use.

Read more about versioning and our version history here.

Path Parameters

message_batch_id · string · required

ID of the Message Batch.

Query Parameters

beta · enum<boolean> · required

Selects the beta API contract for this endpoint. Must be true.

Available options: true

Response

200

application/x-jsonl

Successful Response

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

custom_id · string · required

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.

Example:

"my-custom-id-1"

result · SucceededResult · object · required

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.

SucceededResult

ErroredResult

CanceledResult

ExpiredResult

Show child attributes