Skip to main content
GET
Get a scenario batch

Authorizations

Authorization
string
header
required

An app API key, e.g. Authorization: Bearer sk_live_…. Secret (sk_) for writes/sessions; publishable (pk_) is read-only (browser-safe).

Path Parameters

id
string<uuid>
required

Response

The batch with items

A durable scenario-variation batch (returned by create + GET /v1/scenario-batches/{id}).

batchId
string<uuid>
status
enum<string>
Available options:
queued,
running,
succeeded,
failed,
cancelled
prompt
string | null
spec
object | null

The full canonical scenario spec that was submitted.

itemsTotal
integer
itemsDone
integer
error
string | null
createdAt
string<date-time>
updatedAt
string<date-time>
items
object[]
schemaVersion
integer
Example:

1