Skip to main content
GET
/
v1
/
project_score
List project_scores
curl --request GET \
  --url https://api.braintrust.dev/v1/project_score \
  --header 'Authorization: Bearer <token>'
{
  "objects": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "description": "<string>",
      "score_type": "slider",
      "categories": [
        {
          "name": "<string>",
          "value": 123
        }
      ],
      "config": {
        "multi_select": true,
        "destination": "<string>",
        "online": {
          "sampling_rate": 0.5,
          "scorers": [
            {
              "type": "function",
              "id": "<string>"
            }
          ],
          "btql_filter": "<string>",
          "apply_to_root_span": true,
          "apply_to_span_names": [
            "<string>"
          ],
          "skip_logging": true
        }
      },
      "position": "<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

​
project_score_name
string

Name of the project_score 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

​
score_type

The type of the configured score

Available options:
slider,
categorical,
weighted,
minimum,
maximum,
online,
free-form

Response

Returns a list of project_score objects

​
objects
object[]
required

A list of project_score objects