Skip to main content
PATCH
/
v1
/
dataset
/
{dataset_id}
Partially update dataset
curl --request PATCH \
  --url https://api.braintrust.dev/v1/dataset/{dataset_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "metadata": {}
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {}
}

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

​
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

​
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

​
metadata
object | null

User-controlled metadata about the dataset