Skip to main content
GET
/
v1
/
dataset
/
{dataset_id}
/
summarize
Summarize dataset
curl --request GET \
  --url https://api.braintrust.dev/v1/dataset/{dataset_id}/summarize \
  --header 'Authorization: Bearer <token>'
{
  "project_name": "<string>",
  "dataset_name": "<string>",
  "project_url": "<string>",
  "dataset_url": "<string>",
  "data_summary": {
    "total_records": 1
  }
}

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

Query Parameters

​
summarize_data
boolean | null

Whether to summarize the data. If false (or omitted), only the metadata will be returned.

Response

Dataset summary

Summary of a dataset

​
project_name
string
required

Name of the project that the dataset belongs to

​
dataset_name
string
required

Name of the dataset

​
project_url
string<uri>
required

URL to the project's page in the Braintrust app

​
dataset_url
string<uri>
required

URL to the dataset's page in the Braintrust app

​
data_summary
object

Summary of a dataset's data