Reference/API/Project Scores

List project_scores

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

GET /v1/project_score

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

Query Parameters

limitinteger

Limit the number of objects to return

Minimum: 0
starting_afterstring

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_beforestring

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"
idsAny 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

project_score_namestring

Name of the project_score to search for

project_namestring

Name of the project to search for

project_idstring

Project id

Format: "uuid"
org_namestring

Filter search results to within a particular organization

score_typeAny properties in project_score_type_single, array<project_score_type_single & project_score_type>
curl -X GET "https://api.braintrust.dev/v1/project_score?limit=0&starting_after=497f6eca-6276-4993-bfeb-53cbbbba6f08&ending_before=497f6eca-6276-4993-bfeb-53cbbbba6f08&ids=497f6eca-6276-4993-bfeb-53cbbbba6f08&project_score_name=string&project_name=string&project_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&org_name=string&score_type=slider" \
  -H "Authorization: Bearer <token>"

Returns a list of project_score objects

{
  "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",
      "name": "string",
      "description": "string",
      "score_type": "slider",
      "categories": [
        {
          "name": "string",
          "value": 0
        }
      ],
      "config": {
        "multi_select": true,
        "destination": "string",
        "online": {
          "sampling_rate": 1,
          "scorers": [
            {
              "type": "function",
              "id": "string"
            }
          ],
          "apply_to_root_span": true,
          "apply_to_span_names": [
            "string"
          ],
          "skip_logging": true
        }
      },
      "position": "string"
    }
  ]
}

Create project_score

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

POST /v1/project_score

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 project_score object

project_id
Required
string

Unique identifier for the project that the project score belongs under

Format: "uuid"
name
Required
string

Name of the project score

descriptionstring

Textual description of the project score

score_type
Required
project_score_type_single

The type of the configured score

Value in: "slider" | "categorical" | "weighted" | "minimum" | "maximum" | "online" | "free-form"
categoriesAny properties in categorical, weighted, minimum
configobject
curl -X POST "https://api.braintrust.dev/v1/project_score" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
    "name": "string",
    "description": "string",
    "score_type": "slider",
    "categories": [
      {
        "name": "string",
        "value": 0
      }
    ],
    "config": {
      "multi_select": true,
      "destination": "string",
      "online": {
        "sampling_rate": 1,
        "scorers": [
          {
            "type": "function",
            "id": "string"
          }
        ],
        "apply_to_root_span": true,
        "apply_to_span_names": [
          "string"
        ],
        "skip_logging": true
      }
    }
  }'

Returns the new project_score object

{
  "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",
  "name": "string",
  "description": "string",
  "score_type": "slider",
  "categories": [
    {
      "name": "string",
      "value": 0
    }
  ],
  "config": {
    "multi_select": true,
    "destination": "string",
    "online": {
      "sampling_rate": 1,
      "scorers": [
        {
          "type": "function",
          "id": "string"
        }
      ],
      "apply_to_root_span": true,
      "apply_to_span_names": [
        "string"
      ],
      "skip_logging": true
    }
  },
  "position": "string"
}

Create or replace project_score

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

PUT /v1/project_score

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 project_score object

project_id
Required
string

Unique identifier for the project that the project score belongs under

Format: "uuid"
name
Required
string

Name of the project score

descriptionstring

Textual description of the project score

score_type
Required
project_score_type_single

The type of the configured score

Value in: "slider" | "categorical" | "weighted" | "minimum" | "maximum" | "online" | "free-form"
categoriesAny properties in categorical, weighted, minimum
configobject
curl -X PUT "https://api.braintrust.dev/v1/project_score" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
    "name": "string",
    "description": "string",
    "score_type": "slider",
    "categories": [
      {
        "name": "string",
        "value": 0
      }
    ],
    "config": {
      "multi_select": true,
      "destination": "string",
      "online": {
        "sampling_rate": 1,
        "scorers": [
          {
            "type": "function",
            "id": "string"
          }
        ],
        "apply_to_root_span": true,
        "apply_to_span_names": [
          "string"
        ],
        "skip_logging": true
      }
    }
  }'

Returns the new project_score object

{
  "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",
  "name": "string",
  "description": "string",
  "score_type": "slider",
  "categories": [
    {
      "name": "string",
      "value": 0
    }
  ],
  "config": {
    "multi_select": true,
    "destination": "string",
    "online": {
      "sampling_rate": 1,
      "scorers": [
        {
          "type": "function",
          "id": "string"
        }
      ],
      "apply_to_root_span": true,
      "apply_to_span_names": [
        "string"
      ],
      "skip_logging": true
    }
  },
  "position": "string"
}

Get project_score

Get a project_score object by its id

GET /v1/project_score/{project_score_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

project_score_id
Required
string

ProjectScore id

Format: "uuid"
curl -X GET "https://api.braintrust.dev/v1/project_score/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer <token>"

Returns the project_score object

{
  "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",
  "name": "string",
  "description": "string",
  "score_type": "slider",
  "categories": [
    {
      "name": "string",
      "value": 0
    }
  ],
  "config": {
    "multi_select": true,
    "destination": "string",
    "online": {
      "sampling_rate": 1,
      "scorers": [
        {
          "type": "function",
          "id": "string"
        }
      ],
      "apply_to_root_span": true,
      "apply_to_span_names": [
        "string"
      ],
      "skip_logging": true
    }
  },
  "position": "string"
}

Partially update project_score

Partially update a project_score 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.

PATCH /v1/project_score/{project_score_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

Fields to update

namestring

Name of the project score

descriptionstring

Textual description of the project score

score_typeproject_score_type_single

The type of the configured score

Value in: "slider" | "categorical" | "weighted" | "minimum" | "maximum" | "online" | "free-form"
categoriesAny properties in categorical, weighted, minimum
configobject

Path Parameters

project_score_id
Required
string

ProjectScore id

Format: "uuid"
curl -X PATCH "https://api.braintrust.dev/v1/project_score/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "score_type": "slider",
    "categories": [
      {
        "name": "string",
        "value": 0
      }
    ],
    "config": {
      "multi_select": true,
      "destination": "string",
      "online": {
        "sampling_rate": 1,
        "scorers": [
          {
            "type": "function",
            "id": "string"
          }
        ],
        "apply_to_root_span": true,
        "apply_to_span_names": [
          "string"
        ],
        "skip_logging": true
      }
    }
  }'

Returns the project_score object

{
  "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",
  "name": "string",
  "description": "string",
  "score_type": "slider",
  "categories": [
    {
      "name": "string",
      "value": 0
    }
  ],
  "config": {
    "multi_select": true,
    "destination": "string",
    "online": {
      "sampling_rate": 1,
      "scorers": [
        {
          "type": "function",
          "id": "string"
        }
      ],
      "apply_to_root_span": true,
      "apply_to_span_names": [
        "string"
      ],
      "skip_logging": true
    }
  },
  "position": "string"
}

Delete project_score

Delete a project_score object by its id

DELETE /v1/project_score/{project_score_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

project_score_id
Required
string

ProjectScore id

Format: "uuid"
curl -X DELETE "https://api.braintrust.dev/v1/project_score/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer <token>"

Returns the deleted project_score object

{
  "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",
  "name": "string",
  "description": "string",
  "score_type": "slider",
  "categories": [
    {
      "name": "string",
      "value": 0
    }
  ],
  "config": {
    "multi_select": true,
    "destination": "string",
    "online": {
      "sampling_rate": 1,
      "scorers": [
        {
          "type": "function",
          "id": "string"
        }
      ],
      "apply_to_root_span": true,
      "apply_to_span_names": [
        "string"
      ],
      "skip_logging": true
    }
  },
  "position": "string"
}

On this page