---
title: "Summarize dataset"
method: GET
path: "/v1/dataset/{dataset_id}/summarize"
tags: ["Datasets"]
---

# Summarize dataset

`GET /v1/dataset/{dataset_id}/summarize`

Summarize dataset

## Path parameters

- `dataset_id` string, uuid, required — Dataset id

## Query parameters

- `summarize_data` boolean, nullable — Whether to summarize the data. If false (or omitted), only the metadata will be returned.

## Response `200`

Dataset summary

- SummarizeDatasetResponse — 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` DataSummary, nullable — Summary of a dataset's data
    - `total_records` integer, required — Total number of records in the dataset

## Other responses

- `400` — The request was unacceptable, often due to missing a required parameter
- `401` — No valid API key provided
- `403` — The API key doesn’t have permissions to perform the request
- `429` — Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
- `500` — Something went wrong on Braintrust's end. (These are rare.)

## Changes

- **2024-09-30** `ac2727014d93` — 5 breaking
  - the response's body became nullable
  - the response's body became nullable
  - the response's body became nullable
  - the response's body became nullable
  - …1 more
- **2024-05-06** `44b51ad3239a` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/braintrustdata/apis/braintrust-api/changes/v1/dataset/:dataset_id/summarize/get.md)

---

[API](https://skmtc.dev/braintrustdata/apis/braintrust-api.md) · [All operations](https://skmtc.dev/braintrustdata/apis/braintrust-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/braintrustdata/braintrust-api/revisions/9d216c8243fe/schema)