Braintest
GET/v1/experiment/{experiment_id}/summarize

Summarize an experiment

Retrieves a summary of an experiment, including its project and experiment metadata and, optionally, scores and metrics. Set summarize_scores to true to include score and metric summaries, and use comparison_experiment_id to select the experiment used for comparison. When no comparison identifier is supplied, the API falls back to the experiment metadata or the most recent experiment run in the same project.

3 parameters
experiment_idstringrequired

The unique experiment identifier in UUID format.

summarize_scoresbooleanoptional

Whether to include summaries of scores and metrics. Defaults to false when omitted.

comparison_experiment_idstringoptional

The UUID of the experiment to use as the score and metric comparison baseline. It is used only when summarize_scores is true; otherwise the API falls back to the experiment metadata or the most recent run in the same project.

6 status codes
200Returns an experiment summary containing the project name, experiment name, project URL, experiment URL, and, when requested, comparison experiment name, score summaries, and metric summaries.
project_namestringrequired

Name of the project that the experiment belongs to

experiment_namestringrequired

Name of the experiment

project_urlstringrequired

URL to the project's page in the Braintrust app

experiment_urlstringrequired

URL to the experiment's page in the Braintrust app

comparison_experiment_namestringoptional

The experiment which scores are baselined against

scoresobjectoptional

Summary of the experiment's scores

metricsobjectoptional

Summary of the experiment's metrics

400Returned when a request parameter is unacceptable, including an invalid UUID value.
401Returned when the request does not include a valid API key.
403Returned when the API key does not have permission to retrieve the experiment summary.
429Returned when the API receives too many requests too quickly.
500Returned when an internal server error occurs.

Error handling

A 400 is returned when experiment_id or comparison_experiment_id is not a valid UUID, or when the request parameters are unacceptable. comparison_experiment_id is used only when summarize_scores is true. A 401 is returned without a valid API key, a 403 indicates insufficient permission, a 429 indicates excessive request volume, and a 500 indicates an internal server error.