Skip to main content
GET
/
v1
/
experiment
List experiments
curl --request GET \
  --url https://api.braintrust.dev/v1/experiment \
  --header 'Authorization: Bearer <token>'
{
  "objects": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "repo_info": {
        "commit": "<string>",
        "branch": "<string>",
        "tag": "<string>",
        "dirty": true,
        "author_name": "<string>",
        "author_email": "<string>",
        "commit_message": "<string>",
        "commit_time": "<string>",
        "git_diff": "<string>"
      },
      "commit": "<string>",
      "base_exp_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deleted_at": "2023-11-07T05:31:56Z",
      "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dataset_version": "<string>",
      "public": true,
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata": {},
      "tags": [
        "<string>"
      ]
    }
  ]
}

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.

Query Parameters

​
limit
integer | null

Limit the number of objects to return

Required range: x >= 0
​
starting_after
string<uuid>

Pagination cursor id.

For example, if the final item in the last page you fetched had an id of foo, pass starting_after=foo to fetch the next page. Note: you may only pass one of starting_after and ending_before

​
ending_before
string<uuid>

Pagination cursor id.

For example, if the initial item in the last page you fetched had an id of foo, pass ending_before=foo to fetch the previous page. Note: you may only pass one of starting_after and ending_before

​
ids

Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times

​
experiment_name
string

Name of the experiment to search for

​
project_name
string

Name of the project to search for

​
project_id
string<uuid>

Project id

​
org_name
string

Filter search results to within a particular organization

Response

Returns a list of experiment objects

​
objects
object[]
required

A list of experiment objects