Skip to main content
PATCH
Partially update dataset

Authorizations

Authorization
string
header
required

Most Braintrust endpoints are authenticated by providing your API key as a header Authorization: Bearer [api_key] to your HTTP request. You can create an API key in the Braintrust organization settings page.

Path Parameters

dataset_id
string<uuid>
required

Dataset id

Body

application/json

Fields to update

name
string | null

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

description
string | null

Textual description of the dataset

tags
string[] | null

A list of tags for the dataset

metadata
object | null

User-controlled metadata about the dataset

Response

Returns the dataset object

id
string<uuid>
required

Unique identifier for the dataset

project_id
string<uuid>
required

Unique identifier for the project that the dataset belongs under

name
string
required

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

url_slug
string
required

URL slug for the dataset. used to construct dataset URLs

description
string | null

Textual description of the dataset

created
string<date-time> | null

Date of dataset creation

deleted_at
string<date-time> | null

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

user_id
string<uuid> | null

Identifies the user who created the dataset

tags
string[] | null

A list of tags for the dataset

metadata
object | null

User-controlled metadata about the dataset