Skip to main content
POST
/
v1
/
project_score
Create project_score
curl --request POST \
  --url https://api.braintrust.dev/v1/project_score \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "score_type": "slider",
  "description": "<string>",
  "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
    }
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "score_type": "slider",
  "created": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "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.

Body

application/json

Any desired information about the new project_score object

A project score is a user-configured score, which can be manually-labeled through the UI

​
project_id
string<uuid>
required

Unique identifier for the project that the project score belongs under

​
name
string
required

Name of the project score

​
score_type
enum<string>
required

The type of the configured score

Available options:
slider,
categorical,
weighted,
minimum,
maximum,
online,
free-form
​
description
string | null

Textual description of the project score

​
categories

For categorical-type project scores, the list of all categories

​
config
object

Response

Returns the new project_score object

A project score is a user-configured score, which can be manually-labeled through the UI

​
id
string<uuid>
required

Unique identifier for the project score

​
project_id
string<uuid>
required

Unique identifier for the project that the project score belongs under

​
user_id
string<uuid>
required
​
name
string
required

Name of the project score

​
score_type
enum<string>
required

The type of the configured score

Available options:
slider,
categorical,
weighted,
minimum,
maximum,
online,
free-form
​
created
string<date-time> | null

Date of project score creation

​
description
string | null

Textual description of the project score

​
categories

For categorical-type project scores, the list of all categories

​
config
object
​
position
string | null

An optional LexoRank-based string that sets the sort position for the score in the UI