Custom Viewers - Docs - Custom Viewers

GET

/v1/custom_viewer

List custom_viewers

List out all custom_viewers. The custom_viewers are sorted by creation date, with the most recently-created custom_viewers 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

`custom_viewer_name`string

Name of the custom_viewer to search for

`project_name`string

Name of the project to search for

`project_id`string

Project id

Format: "uuid"

`org_name`string

Filter search results to within a particular organization

Status code	Description
`200`	Returns a list of custom_viewer objects
`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.)

curl -X GET "https://api.braintrust.dev/v1/custom_viewer?limit=0&starting_after=497f6eca-6276-4993-bfeb-53cbbbba6f08&ending_before=497f6eca-6276-4993-bfeb-53cbbbba6f08&ids=497f6eca-6276-4993-bfeb-53cbbbba6f08&custom_viewer_name=string&project_name=string&project_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&org_name=string"

{
  "objects": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
      "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
      "created": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "description": "string",
      "url": "string"
    }
  ]
}

POST

/v1/custom_viewer

Create custom_viewer

Create a new custom_viewer. If there is an existing custom_viewer in the project with the same name as the one specified in the request, will return the existing custom_viewer 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 (Optional)

Any desired information about the new custom_viewer object

`project_id`
Required
string

Unique identifier for the project that the custom viewer belongs under

Format: "uuid"

`user_id`string | null

Identifies the user who created the custom viewer

Format: "uuid"

`name`
Required
string

Name of the custom viewer

`description`string | null

Textual description of the custom viewer

`url`
Required
string

URL to embed the project viewer in an iframe

Status code	Description
`200`	Returns the new custom_viewer object
`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.)

curl -X POST "https://api.braintrust.dev/v1/custom_viewer" \
  -d '{
  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "name": "string",
  "description": "string",
  "url": "string"
}'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "created": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "url": "string"
}

PUT

/v1/custom_viewer

Create or replace custom_viewer

Create or replace custom_viewer. If there is an existing custom_viewer in the project with the same name as the one specified in the request, will replace the existing custom_viewer 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 (Optional)

Any desired information about the new custom_viewer object

`project_id`
Required
string

Unique identifier for the project that the custom viewer belongs under

Format: "uuid"

`user_id`string | null

Identifies the user who created the custom viewer

Format: "uuid"

`name`
Required
string

Name of the custom viewer

`description`string | null

Textual description of the custom viewer

`url`
Required
string

URL to embed the project viewer in an iframe

Status code	Description
`200`	Returns the new custom_viewer object
`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.)

curl -X PUT "https://api.braintrust.dev/v1/custom_viewer" \
  -d '{
  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "name": "string",
  "description": "string",
  "url": "string"
}'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "created": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "url": "string"
}

GET

/v1/custom_viewer/{custom_viewer_id}

Get custom_viewer

Get a custom_viewer 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

`custom_viewer_id`
Required
string

CustomViewer id

Format: "uuid"

Status code	Description
`200`	Returns the custom_viewer object
`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.)

curl -X GET "https://api.braintrust.dev/v1/custom_viewer/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "created": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "url": "string"
}

PATCH

/v1/custom_viewer/{custom_viewer_id}

Partially update custom_viewer

Partially update a custom_viewer 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 (Optional)

Fields to update

`name`string | null

Name of the custom viewer

`url`string | null

URL to embed the project viewer in an iframe

Path Parameters

`custom_viewer_id`
Required
string

CustomViewer id

Format: "uuid"

Status code	Description
`200`	Returns the custom_viewer object
`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.)

curl -X PATCH "https://api.braintrust.dev/v1/custom_viewer/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -d '{
  "name": "string",
  "url": "string"
}'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "created": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "url": "string"
}

DELETE

/v1/custom_viewer/{custom_viewer_id}

Delete custom_viewer

Delete a custom_viewer 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

`custom_viewer_id`
Required
string

CustomViewer id

Format: "uuid"

Status code	Description
`200`	Returns the deleted custom_viewer object
`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.)

curl -X DELETE "https://api.braintrust.dev/v1/custom_viewer/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "created": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "url": "string"
}

Query

AuthorizationRequiredBearer <token>

limitinteger | null

starting_afterstring

ending_beforestring

idsAny properties in string, array<string>

Object 1

custom_viewer_namestring

project_namestring

project_idstring

org_namestring

Response

Typescript

Body

AuthorizationRequiredBearer <token>

project_idRequiredstring

user_idstring | null

nameRequiredstring

descriptionstring | null

urlRequiredstring

Response

Typescript

Body

AuthorizationRequiredBearer <token>

project_idRequiredstring

user_idstring | null

nameRequiredstring

descriptionstring | null

urlRequiredstring

Response

Typescript

Path

AuthorizationRequiredBearer <token>

custom_viewer_idRequiredstring

Response

Typescript

Path

Body

AuthorizationRequiredBearer <token>

namestring | null

urlstring | null

custom_viewer_idRequiredstring

Response

Typescript

Path

AuthorizationRequiredBearer <token>

custom_viewer_idRequiredstring

Response

Typescript

On this page

Query

Body

Body

Path

Path

Body

Path

`Authorization`
Required
Bearer <token>

`limit`integer | null

`starting_after`string

`ending_before`string

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

`custom_viewer_name`string

`project_name`string

`project_id`string

`org_name`string

`Authorization`
Required
Bearer <token>

`project_id`
Required
string

`user_id`string | null

`name`
Required
string

`description`string | null

`url`
Required
string

`Authorization`
Required
Bearer <token>

`project_id`
Required
string

`user_id`string | null

`name`
Required
string

`description`string | null

`url`
Required
string

`Authorization`
Required
Bearer <token>

`custom_viewer_id`
Required
string

`Authorization`
Required
Bearer <token>

`name`string | null

`url`string | null

`custom_viewer_id`
Required
string

`Authorization`
Required
Bearer <token>

`custom_viewer_id`
Required
string