Braintest
GET/v1/experiment/{experiment_id}

Get an experiment

Retrieves one experiment by its unique identifier. Use experiment_id to obtain the experiment's project association, metadata, creation details, visibility, and linked dataset information.

1 parameter
experiment_idstringrequired
The UUID of the experiment to retrieve.

6 status codes
200Returns the experiment object, including its `id`, `project_id`, `name`, `public` status, creation details, repository metadata, optional dataset linkage, and user-controlled metadata.
idstringrequired
Unique identifier for the experiment
project_idstringrequired
Unique identifier for the project that the experiment belongs under
namestringrequired
Name of the experiment. Within a project, experiment names are unique
descriptionstringoptional
Textual description of the experiment
createdstringoptional
Date of experiment creation
repo_infoobjectoptional
Metadata about the state of the repo when the experiment was created
commitstringoptional
Commit, taken directly from `repo_info.commit`
base_exp_idstringoptional
Id of default base experiment to compare against when viewing this experiment
deleted_atstringoptional
Date of experiment deletion, or null if the experiment is still active
dataset_idstringoptional
Identifier of the linked dataset, or null if the experiment is not linked to a dataset
dataset_versionstringoptional
Version number of the linked dataset the experiment was run against. This can be used to reproduce the experiment after the dataset has been modified.
publicbooleanrequired
Whether or not the experiment is public. Public experiments can be viewed by anybody inside or outside the organization
user_idstringoptional
Identifies the user who created the experiment
metadataobjectoptional
User-controlled metadata about the experiment
400Returned when the request is unacceptable, often because `experiment_id` is missing or invalid.
401Returned when no valid API key is provided.
403Returned when the API key does not have permission to retrieve the experiment.
429Returned when too many requests are sent too quickly.
500Returned when an error occurs on the API owner's side.

Error handling

A 400 is returned when experiment_id is unacceptable; it must be a valid UUID. A 401 indicates that no valid API key was provided, a 403 indicates that the API key lacks permission, a 429 indicates that requests are being sent too quickly, and a 500 indicates an error on the API owner's side.