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>'
import requests

url = "https://api.braintrust.dev/v1/project_score"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.braintrust.dev/v1/project_score', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.braintrust.dev/v1/project_score",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.braintrust.dev/v1/project_score"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.braintrust.dev/v1/project_score")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.braintrust.dev/v1/project_score")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "objects": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "categories": [
        {
          "name": "<string>",
          "value": 123
        }
      ],
      "config": {
        "multi_select": true,
        "destination": "<string>",
        "visibility": {
          "users": [
            "<string>"
          ],
          "groups": [
            "<string>"
          ]
        },
        "online": {
          "sampling_rate": 0.5,
          "scorers": [
            {
              "type": "function",
              "id": "<string>",
              "version": "<string>"
            }
          ],
          "btql_filter": "<string>",
          "apply_to_root_span": true,
          "apply_to_span_names": [
            "<string>"
          ],
          "skip_logging": true,
          "scope": {
            "type": "span"
          }
        },
        "condition": {
          "when": {
            "clauses": [
              "<string>"
            ],
            "subspan_clauses": [
              "<string>"
            ],
            "trace_clauses": [
              "<string>"
            ]
          },
          "behavior": "hidden"
        },
        "object_types": []
      },
      "position": "<string>"
    }
  ]
}
"<string>"
"<string>"
"<string>"
"<string>"
"<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