Skip to main content
POST
Create a batch

Authorizations

Authorization
string
header
required

A long-lived, privileged API key (ek_... prefix), minted once from the dashboard. Intended for trusted server-side use only; never expose it in client-side code. Send as Authorization: Bearer ek_.... Required by every Calls, Batches, Agents, Tools, MCP Servers, Documents, and Realtime route.

Body

application/json
agent_id
string
required
name
string
required
recipients
V1BatchRecipient · object[]
required
provider
string | null
scheduled_at
string | null
webhook_url
string | null

Response

Successful Response

batch_id
string
required
agent_id
string
required
name
string
required
status
string
required
total
integer
required
skipped
Skipped · object
required
created_at
string<date-time>
required
provider
string | null
scheduled_at
string<date-time> | null