Braintest
GET/v1/dataset/{dataset_id}

Get a dataset

Retrieves one dataset by its unique identifier. Provide dataset_id as a UUID to retrieve the dataset object and its project association, metadata, and lifecycle timestamps. Use the returned id and project_id to reference the dataset and its parent project.

1 parameter
dataset_idstringrequired

The unique identifier of the dataset to retrieve, in UUID format.

6 status codes
200Returns the dataset object with its id, project_id, name, description, creation and deletion timestamps, creator identifier, and user-controlled metadata.
idstringrequired

Unique identifier for the dataset

project_idstringrequired

Unique identifier for the project that the dataset belongs under

namestringrequired

Name of the dataset. Within a project, dataset names are unique

descriptionstringoptional

Textual description of the dataset

createdstringoptional

Date of dataset creation

deleted_atstringoptional

Date of dataset deletion, or null if the dataset is still active

user_idstringoptional

Identifies the user who created the dataset

metadataobjectoptional

User-controlled metadata about the dataset

400Returned when the request is unacceptable, often because a required parameter is missing.
401Returned when no valid API key is provided.
403Returned when the API key does not have permission to retrieve the dataset.
429Returned when too many requests arrive too quickly; use exponential backoff before retrying.
500Returned when an internal service error occurs.

Error handling

dataset_id must be a valid UUID that identifies the dataset to retrieve. A 400 is returned for an unacceptable request, a 401 when no valid API key is provided, and a 403 when the API key lacks permission. A 429 indicates excessive request frequency, while a 500 indicates an internal service failure.