Skip to main content
GET
/
v1
/
view
List views
curl --request GET \
  --url https://api.braintrust.dev/v1/view \
  --header 'Authorization: Bearer <token>'
{
  "objects": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "object_type": "organization",
      "object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "view_type": "projects",
      "name": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "view_data": {
        "search": {
          "filter": [
            "<unknown>"
          ],
          "tag": [
            "<unknown>"
          ],
          "match": [
            "<unknown>"
          ],
          "sort": [
            "<unknown>"
          ]
        },
        "custom_charts": "<unknown>"
      },
      "options": {
        "viewType": "monitor",
        "options": {
          "spanType": "range",
          "rangeValue": "<string>",
          "frameStart": "<string>",
          "frameEnd": "<string>",
          "tzUTC": true,
          "chartVisibility": {},
          "projectId": "<string>",
          "type": "project",
          "groupBy": "<string>"
        },
        "freezeColumns": true
      },
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ]
}

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

​
view_name
string

Name of the view to search for

​
view_type
enum<string>

Type of object that the view corresponds to.

Available options:
projects,
experiments,
experiment,
playgrounds,
playground,
datasets,
dataset,
prompts,
tools,
scorers,
logs,
monitor,
for_review,
​
object_type
enum<string>
required

The object type that the ACL applies to

Available options:
organization,
project,
experiment,
dataset,
prompt,
prompt_session,
group,
role,
org_member,
project_log,
org_project
​
object_id
string<uuid>
required

The id of the object the ACL applies to

Response

Returns a list of view objects

​
objects
object[]
required

A list of view objects