Skip to main content
POST
Core - Create an experiment
Related guide: Experiments guide. See the Experiments guide for a walkthrough with examples.

Authorizations

Authorization
string
header
required

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

Body

application/json
display_name
string
required

Experiment name, 1 to 255 characters.

project_id
string

Project the experiment is created in. Defaults to the caller's project: the API key's project, or the project open in the AI Studio. Required for API keys that span several projects.

dataset_id
string

Dataset whose datapoints become the rows of the first run, at most 1000. Must be in the experiment's project. Omit to start with an empty run.

source_run
object

Run to fork. Its task, metric, evaluator and review columns are copied into the new experiment's first run; rows still come from dataset_id. Must be in the same project as the new experiment.

Response

OK

An experiment: a dataset evaluated by one or more runs.

experiment_id
string

Experiment ID (ULID).

display_name
string

Experiment name.

project_id
string

Project that owns the experiment.

dataset_id
string

Dataset whose datapoints become the rows of each new run. Empty when the experiment was created without a dataset.

selected_run_id
string

Run shown by default in the AI Studio, and the run whose columns Create a run copies. Create a run selects the new run; deleting the selected run selects the newest remaining one.

created_at
string<date-time>

Creation time.

updated_at
string<date-time>

Time of the last update to the experiment.

source
string

Origin of the experiment: evaluatorq for results uploaded by the evaluatorq framework; empty or manual otherwise.

row_height_level
integer<int32>

Row height in the AI Studio grid: 1 (compact), 2 or 3 (tallest). Set to 1 on create.

unique_evaluators
object[]

Evaluators used by the experiment's evaluator columns, one entry per evaluator.

created_by_id
string

ID of the user or API key that created the experiment.