---
title: "Summarize experiment"
method: GET
path: "/v1/experiment/{experiment_id}/summarize"
tags: ["Experiments"]
---

# Summarize experiment

`GET /v1/experiment/{experiment_id}/summarize`

Summarize experiment

## Path parameters

- `experiment_id` string, uuid, required — Experiment id

## Query parameters

- `summarize_scores` boolean, nullable — Whether to summarize the scores and metrics. If false (or omitted), only the metadata will be returned.
- `comparison_experiment_id` string, uuid — The experiment to compare against, if summarizing scores and metrics. If omitted, will fall back to the `base_exp_id` stored in the experiment metadata, and then to the most recent experiment run in the same project. Must pass `summarize_scores=true` for this id to be used

## Response `200`

Experiment summary

- SummarizeExperimentResponse — Summary of an experiment
  - `project_name` string, required — Name of the project that the experiment belongs to
  - `experiment_name` string, required — Name of the experiment
  - `project_url` string, uri, required — URL to the project's page in the Braintrust app
  - `experiment_url` string, uri, required — URL to the experiment's page in the Braintrust app
  - `comparison_experiment_name` string, nullable — The experiment which scores are baselined against
  - `scores` object, nullable — Summary of the experiment's scores
  - `metrics` object, nullable — Summary of the experiment's metrics

## 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.)

---

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