Skip to main content
POST
Create experiment

Authorizations

Authorization
string
header
required

API key issued from Settings → API Keys. Pass as Authorization: Bearer <key>.

Path Parameters

id
string
required

Automation id or typed alias.

Body

application/json

Request body for starting an experiment batch.

examples
string[]

Optional dataset example ids to run. Omit to run the full dataset.

batchConcurrency
integer | null

Maximum concurrent example runs for this experiment.

Required range: 0 < x <= 9007199254740991
sourceRef
string

Optional source version/ref to use for experiment runs.

Response

Experiment accepted and runs enqueued.

Accepted experiment batch and the runs it enqueued.

id
string
required

Experiment batch id.

runs
object[]
required

Runs enqueued for this experiment.

total
integer
required

Number of runs enqueued.

Required range: -9007199254740991 <= x <= 9007199254740991