Views - Docs - Braintrust

GET

/v1/view

List views

List out all views. The views are sorted by creation date, with the most recently-created views coming first

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.

In: header

Query Parameters

`limit`integer | null

Limit the number of objects to return

Minimum: 0

`starting_after`string

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

Format: "uuid"

`ending_before`string

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

Format: "uuid"

`ids`Any properties in string, array<string>

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`string

Type of table that the view corresponds to.

`object_type`
Required
string

The object type that the ACL applies to

Value in:

"organization" | "project" | "experiment" | "dataset" | "prompt" | "prompt_session" | "group" | "role" | "org_member" | "project_log" | "org_project"

`object_id`
Required
string

The id of the object the ACL applies to

Format: "uuid"

curl -X GET "https://api.braintrust.dev/v1/view?limit=0&starting_after=497f6eca-6276-4993-bfeb-53cbbbba6f08&ending_before=497f6eca-6276-4993-bfeb-53cbbbba6f08&ids=497f6eca-6276-4993-bfeb-53cbbbba6f08&view_name=string&view_type=projects&object_type=organization&object_id=497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer <token>"

Returns a list of view objects

{
  "objects": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "object_type": "organization",
      "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
      "view_type": "projects",
      "name": "string",
      "created": "2019-08-24T14:15:22Z",
      "view_data": {
        "search": {
          "filter": [
            null
          ],
          "tag": [
            null
          ],
          "match": [
            null
          ],
          "sort": [
            null
          ]
        }
      },
      "options": {
        "columnVisibility": {
          "property1": true,
          "property2": true
        },
        "columnOrder": [
          "string"
        ],
        "columnSizing": {
          "property1": 0,
          "property2": 0
        }
      },
      "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
      "deleted_at": "2019-08-24T14:15:22Z"
    }
  ]
}

POST

/v1/view

Create view

Create a new view. If there is an existing view with the same name as the one specified in the request, will return the existing view unmodified

Authorization

`Authorization`
Required
Bearer <token>

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.

In: header

Request Body

application/jsonOptional

Any desired information about the new view object

`object_type`
Required
string

The object type that the ACL applies to

Value in:

"organization" | "project" | "experiment" | "dataset" | "prompt" | "prompt_session" | "group" | "role" | "org_member" | "project_log" | "org_project"

`object_id`
Required
string

The id of the object the view applies to

Format: "uuid"

`view_type`
Required
string

Type of table that the view corresponds to.

`name`
Required
string

Name of the view

`view_data`object | null

The view definition

`options`object | null

Options for the view in the app

`user_id`string | null

Identifies the user who created the view

Format: "uuid"

`deleted_at`string | null

Date of role deletion, or null if the role is still active

Format: "date-time"

curl -X POST "https://api.braintrust.dev/v1/view" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "object_type": "organization",
    "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
    "view_type": "projects",
    "name": "string",
    "view_data": {
      "search": {
        "filter": [
          null
        ],
        "tag": [
          null
        ],
        "match": [
          null
        ],
        "sort": [
          null
        ]
      }
    },
    "options": {
      "columnVisibility": {
        "property1": true,
        "property2": true
      },
      "columnOrder": [
        "string"
      ],
      "columnSizing": {
        "property1": 0,
        "property2": 0
      }
    },
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
    "deleted_at": "2019-08-24T14:15:22Z"
  }'

Returns the new view object

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "object_type": "organization",
  "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  "view_type": "projects",
  "name": "string",
  "created": "2019-08-24T14:15:22Z",
  "view_data": {
    "search": {
      "filter": [
        null
      ],
      "tag": [
        null
      ],
      "match": [
        null
      ],
      "sort": [
        null
      ]
    }
  },
  "options": {
    "columnVisibility": {
      "property1": true,
      "property2": true
    },
    "columnOrder": [
      "string"
    ],
    "columnSizing": {
      "property1": 0,
      "property2": 0
    }
  },
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "deleted_at": "2019-08-24T14:15:22Z"
}

PUT

/v1/view

Create or replace view

Create or replace view. If there is an existing view with the same name as the one specified in the request, will replace the existing view with the provided fields

Authorization

`Authorization`
Required
Bearer <token>

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.

In: header

Request Body

application/jsonOptional

Any desired information about the new view object

`object_type`
Required
string

The object type that the ACL applies to

Value in:

"organization" | "project" | "experiment" | "dataset" | "prompt" | "prompt_session" | "group" | "role" | "org_member" | "project_log" | "org_project"

`object_id`
Required
string

The id of the object the view applies to

Format: "uuid"

`view_type`
Required
string

Type of table that the view corresponds to.

`name`
Required
string

Name of the view

`view_data`object | null

The view definition

`options`object | null

Options for the view in the app

`user_id`string | null

Identifies the user who created the view

Format: "uuid"

`deleted_at`string | null

Date of role deletion, or null if the role is still active

Format: "date-time"

curl -X PUT "https://api.braintrust.dev/v1/view" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "object_type": "organization",
    "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
    "view_type": "projects",
    "name": "string",
    "view_data": {
      "search": {
        "filter": [
          null
        ],
        "tag": [
          null
        ],
        "match": [
          null
        ],
        "sort": [
          null
        ]
      }
    },
    "options": {
      "columnVisibility": {
        "property1": true,
        "property2": true
      },
      "columnOrder": [
        "string"
      ],
      "columnSizing": {
        "property1": 0,
        "property2": 0
      }
    },
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
    "deleted_at": "2019-08-24T14:15:22Z"
  }'

Returns the new view object

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "object_type": "organization",
  "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  "view_type": "projects",
  "name": "string",
  "created": "2019-08-24T14:15:22Z",
  "view_data": {
    "search": {
      "filter": [
        null
      ],
      "tag": [
        null
      ],
      "match": [
        null
      ],
      "sort": [
        null
      ]
    }
  },
  "options": {
    "columnVisibility": {
      "property1": true,
      "property2": true
    },
    "columnOrder": [
      "string"
    ],
    "columnSizing": {
      "property1": 0,
      "property2": 0
    }
  },
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "deleted_at": "2019-08-24T14:15:22Z"
}

GET

/v1/view/{view_id}

Get view

Get a view object by its id

Authorization

`Authorization`
Required
Bearer <token>

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.

In: header

Path Parameters

`view_id`
Required
string

View id

Format: "uuid"

Query Parameters

`object_type`
Required
string

The object type that the ACL applies to

Value in:

"organization" | "project" | "experiment" | "dataset" | "prompt" | "prompt_session" | "group" | "role" | "org_member" | "project_log" | "org_project"

`object_id`
Required
string

The id of the object the ACL applies to

Format: "uuid"

curl -X GET "https://api.braintrust.dev/v1/view/497f6eca-6276-4993-bfeb-53cbbbba6f08?object_type=organization&object_id=497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer <token>"

Returns the view object

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "object_type": "organization",
  "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  "view_type": "projects",
  "name": "string",
  "created": "2019-08-24T14:15:22Z",
  "view_data": {
    "search": {
      "filter": [
        null
      ],
      "tag": [
        null
      ],
      "match": [
        null
      ],
      "sort": [
        null
      ]
    }
  },
  "options": {
    "columnVisibility": {
      "property1": true,
      "property2": true
    },
    "columnOrder": [
      "string"
    ],
    "columnSizing": {
      "property1": 0,
      "property2": 0
    }
  },
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "deleted_at": "2019-08-24T14:15:22Z"
}

PATCH

/v1/view/{view_id}

Partially update view

Partially update a view object. Specify the fields to update in the payload. Any object-type fields will be deep-merged with existing content. Currently we do not support removing fields or setting them to null.

Authorization

`Authorization`
Required
Bearer <token>

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.

In: header

Request Body

application/jsonOptional

Fields to update

`object_type`
Required
string

The object type that the ACL applies to

Value in:

"organization" | "project" | "experiment" | "dataset" | "prompt" | "prompt_session" | "group" | "role" | "org_member" | "project_log" | "org_project"

`object_id`
Required
string

The id of the object the view applies to

Format: "uuid"

`view_type`string | null

Type of table that the view corresponds to.

`name`string | null

Name of the view

`view_data`object | null

The view definition

`options`object | null

Options for the view in the app

`user_id`string | null

Identifies the user who created the view

Format: "uuid"

Path Parameters

`view_id`
Required
string

View id

Format: "uuid"

curl -X PATCH "https://api.braintrust.dev/v1/view/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "object_type": "organization",
    "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
    "view_type": "projects",
    "name": "string",
    "view_data": {
      "search": {
        "filter": [
          null
        ],
        "tag": [
          null
        ],
        "match": [
          null
        ],
        "sort": [
          null
        ]
      }
    },
    "options": {
      "columnVisibility": {
        "property1": true,
        "property2": true
      },
      "columnOrder": [
        "string"
      ],
      "columnSizing": {
        "property1": 0,
        "property2": 0
      }
    },
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
  }'

Returns the view object

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "object_type": "organization",
  "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  "view_type": "projects",
  "name": "string",
  "created": "2019-08-24T14:15:22Z",
  "view_data": {
    "search": {
      "filter": [
        null
      ],
      "tag": [
        null
      ],
      "match": [
        null
      ],
      "sort": [
        null
      ]
    }
  },
  "options": {
    "columnVisibility": {
      "property1": true,
      "property2": true
    },
    "columnOrder": [
      "string"
    ],
    "columnSizing": {
      "property1": 0,
      "property2": 0
    }
  },
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "deleted_at": "2019-08-24T14:15:22Z"
}

DELETE

/v1/view/{view_id}

Delete view

Delete a view object by its id

Authorization

`Authorization`
Required
Bearer <token>

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.

In: header

Request Body

application/jsonOptional

Additional parameters for the delete operation

`object_type`
Required
string

The object type that the ACL applies to

Value in:

"organization" | "project" | "experiment" | "dataset" | "prompt" | "prompt_session" | "group" | "role" | "org_member" | "project_log" | "org_project"

`object_id`
Required
string

The id of the object the view applies to

Format: "uuid"

Path Parameters

`view_id`
Required
string

View id

Format: "uuid"

curl -X DELETE "https://api.braintrust.dev/v1/view/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "object_type": "organization",
    "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb"
  }'

Returns the deleted view object

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "object_type": "organization",
  "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  "view_type": "projects",
  "name": "string",
  "created": "2019-08-24T14:15:22Z",
  "view_data": {
    "search": {
      "filter": [
        null
      ],
      "tag": [
        null
      ],
      "match": [
        null
      ],
      "sort": [
        null
      ]
    }
  },
  "options": {
    "columnVisibility": {
      "property1": true,
      "property2": true
    },
    "columnOrder": [
      "string"
    ],
    "columnSizing": {
      "property1": 0,
      "property2": 0
    }
  },
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "deleted_at": "2019-08-24T14:15:22Z"
}

Query

AuthorizationRequiredBearer <token>

limitinteger | null

starting_afterstring

ending_beforestring

idsAny properties in string, array<string>

Object 1

view_namestring

view_typestring

object_typeRequiredstring

object_idRequiredstring

Response

TypeScript

Body

AuthorizationRequiredBearer <token>

object_typeRequiredstring

object_idRequiredstring

view_typeRequiredstring

nameRequiredstring

view_dataobject | null

Attributes

optionsobject | null

Attributes

user_idstring | null

deleted_atstring | null

Response

TypeScript

Body

AuthorizationRequiredBearer <token>

object_typeRequiredstring

object_idRequiredstring

view_typeRequiredstring

nameRequiredstring

view_dataobject | null

Attributes

optionsobject | null

Attributes

user_idstring | null

deleted_atstring | null

Response

TypeScript

Path

Query

AuthorizationRequiredBearer <token>

view_idRequiredstring

object_typeRequiredstring

object_idRequiredstring

Response

TypeScript

Path

Body

AuthorizationRequiredBearer <token>

object_typeRequiredstring

object_idRequiredstring

view_typestring | null

namestring | null

view_dataobject | null

Attributes

optionsobject | null

Attributes

user_idstring | null

view_idRequiredstring

Response

TypeScript

Path

Body

AuthorizationRequiredBearer <token>

object_typeRequiredstring

object_idRequiredstring

view_idRequiredstring

Response

TypeScript

On this page

`Authorization`
Required
Bearer <token>

`limit`integer | null

`starting_after`string

`ending_before`string

`ids`Any properties in string, array<string>

`view_name`string

`view_type`string

`object_type`
Required
string

`object_id`
Required
string

`Authorization`
Required
Bearer <token>

`object_type`
Required
string

`object_id`
Required
string

`view_type`
Required
string

`name`
Required
string

`view_data`object | null

`options`object | null

`user_id`string | null

`deleted_at`string | null

`Authorization`
Required
Bearer <token>

`object_type`
Required
string

`object_id`
Required
string

`view_type`
Required
string

`name`
Required
string

`view_data`object | null

`options`object | null

`user_id`string | null

`deleted_at`string | null

`Authorization`
Required
Bearer <token>

`view_id`
Required
string

`object_type`
Required
string

`object_id`
Required
string

`Authorization`
Required
Bearer <token>

`object_type`
Required
string

`object_id`
Required
string

`view_type`string | null

`name`string | null

`view_data`object | null

`options`object | null

`user_id`string | null

`view_id`
Required
string

`Authorization`
Required
Bearer <token>

`object_type`
Required
string

`object_id`
Required
string

`view_id`
Required
string