Skip to content
API referenceGet the results of a message batch

Get the results of a message batch

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

Get the results of a message batch.

Compatible with Anthropic's Retrieve Message Batch Results API: the ended batch's results as JSONL (application/x-jsonl), one line per request with its custom_id and result, as Anthropic sends them. Reading results bills nothing (the batch is billed once it ends, whether or not the results are read). With a virtual key, only a batch that key created is found; any other id is a 404.

Errors are in Anthropic's shape: 400 for a non-Anthropic or PLATFORM key or x-config; 401 for a missing or invalid credential; 403 for a disabled or expired key; 404 for an unknown batch.

Compatible with the Anthropic Message Batches API. The request and response bodies are the provider's own format, passed through by the gateway: see the Anthropic Message Batches API reference for every field. The credentials and headers below are what VectorAxis adds.

Authorization

  • AuthorizationBearer <slug>.<secret>

    A virtual key's API key (vk-....<secret>), as Authorization: Bearer. What the OpenAI SDK sends from its api_key. Used by the inference endpoints.

  • orx-virtual-keyheader

    A virtual key's API key in the x-virtual-key header, for clients that keep Authorization for something else.

  • orx-api-keyheader

    Direct credentials: the provider's own API key in x-api-key, with the provider named in x-provider (for example openai). On /v1/messages a virtual key is accepted in x-api-key too, which is what the Claude SDK sends.

Path parameters

  • batchIdstringrequired

    the batch id (msgbatch_...)

Headers

  • x-providerstring

    With direct credentials: the provider x-api-key belongs to, for example openai or anthropic (case and dashes are normalised). Not used with a virtual key.

  • anthropic-betastring

    Anthropic beta features, comma-separated (for example context-management-2025-06-27). Forwarded to Anthropic and Claude on Vertex only; at most 32 names of lower-case letters, digits and dashes.

Responses

200application/json
NVIDIA Inception Program member

VectorAxis is built by GK Labs, a member of NVIDIA Inception.