Skip to main content
GET
Get a batch
  • Returns at once. While the batch runs, Retry-After suggests when to read it again.
  • Each item’s result is handed out once, as a run’s is. One answer carries at most 1 MiB of results; more_results says to read again for the rest. include_result=false reads everything else and leaves the results for later.
  • Callers: an API key, an integration’s API key, an MCP OAuth token or a Dashboard session.
  • Permission: jobs:read.
  • Effect: Changes nothing.
  • Errors: not_found, business_account_required, and the errors any request can get.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

a batch ID: batch_ and 32 lowercase hex digits

Example:

"batch_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"

Query Parameters

include_result
enum<string>

false to read the job without its result, which stays for a later read; result_status says whether one waits. Default true.

Available options:
true,
false

Response

The batch

id
string
required

a batch ID: batch_ and 32 lowercase hex digits

Example:

"batch_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"

type
enum<string>
required
Available options:
batch
status
enum<string>
required
Available options:
running,
completed,
cancelled
tool_id
string
required
counts
object
required
items
object[]
required
more_results
boolean
required

true when finished items' results were left out to keep this answer under 1 MiB: read the batch again for them

created_at
string
required

a string to be decoded into a Date

updated_at
string
required

a string to be decoded into a Date

completed_at
string | null
required

a string to be decoded into a Date