Skip to main content
PATCH
Core - Rename 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.

Path Parameters

experiment_id
string
required

ID of the experiment.

Body

application/json
display_name
string

New experiment name, 1 to 255 characters.

selected_run_id
string

Run to show by default. Must be a run of this experiment.

row_height_level
integer<int32>

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

project_id
string

Moves the experiment to another project the caller can access. The dataset stays where it is, so new runs need a dataset in the new project.

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.