Update Experiment

View as Markdown

Path parameters

workspacestringRequired
namestringRequired

Request

This endpoint expects an object.
namestringRequired

Workspace-unique experiment name.

descriptionstringOptional

Human-readable purpose of the experiment.

insight_idstringOptional
Reference to an external insight that seeded this experiment, if any.
summarystringOptional

Human- or agent-authored summary of the experiment’s findings.

metadatamap from strings to stringsOptional

Free-form producer metadata for the experiment.

default_sortstringOptionalDefaults to -created_at

Default sort for this experiment’s evaluations list, as a sort-param string: a comma-separated, ordered list of fields where the first is the primary sort and the rest break ties (leading ’-’ on a field = descending), e.g. ‘-evaluators.reward.mean,cost_usd.mean’. Defaults to ‘-created_at’. Accepts any field the evaluations list sort param does; clients apply it as the list sort param.

paretoobjectOptional

Default X/Y metrics for the experiment’s Pareto view. Omit to preserve the existing value on update; on create, defaults to cost vs. latency.

column_layoutobjectOptional

Saved column order and column visibility for the experiment’s evaluations table. Omit to leave the saved layout unchanged; on create that means no layout is saved. An empty order and hidden pair is itself a saved layout — one that shows every column — and is distinct from having none.

is_favoritebooleanOptionalDefaults to false

Whether this Experiment is marked as a favorite. Defaults to false on create; omit on update to preserve the existing value.

show_evaluations_over_timebooleanOptionalDefaults to false

Whether Studio should display this Experiment’s Evaluation results over time. Defaults to false on create; omit on update to preserve the existing value.

baseline_evaluation_namestring or nullOptional
Name of this Experiment's baseline Evaluation. The Evaluation must already be a live member of the Experiment. Set null to clear the selected baseline.

Response

Successful Response
idstring
namestring
workspacestring
default_sortstring
descriptionstringOptional
insight_idstringOptional
summarystringOptional
metadatamap from strings to stringsOptional
paretoobjectOptional

Default X/Y metrics for a group’s cost-vs-accuracy Pareto view.

Metric ids use the same vocabulary as the evaluations list sort/filter fields — cost_usd, latency_ms, tokens, or evaluators.<name>. Defaults to cost (x) vs latency (y): both exist for every group, so the chart always has something to render before anyone customizes it.

column_layoutobject or nullOptional
Saved column order and column visibility for the experiment's evaluations table. Null when no layout has been saved, which is distinct from a saved layout that hides nothing.
is_favoritebooleanOptionalDefaults to false
Whether this Experiment is marked as a favorite.
show_evaluations_over_timebooleanOptionalDefaults to false
Whether Studio should display this Experiment's Evaluation results over time.
baseline_evaluation_namestringOptional
Name of this Experiment's selected baseline Evaluation, if any.
created_atdatetimeOptional
updated_atdatetimeOptional
evaluation_countintegerOptionalDefaults to 0

Number of live (non-soft-deleted) evaluations in this experiment.

Errors

400
Bad Request Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error