ReferenceAPI
GET
/v1/project_score

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

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

idsstring

Format: "uuid"

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

Status codeDescription
200Returns a list of project_score objects
400The request was unacceptable, often due to missing a required parameter
401No valid API key provided
403The API key doesn’t have permissions to perform the request
429Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
500Something went wrong on Braintrust's end. (These are rare.)
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"

{
  "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": "expected"
      },
      "position": "string"
    }
  ]
}

POST
/v1/project_score

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

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 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 | null

Textual description of the project score

score_type
Required
string

The type of the configured score

Value in: "slider" | "categorical" | "weighted" | "minimum" | null

categoriesAny properties in categorical, weighted, minimum, nullableVariant | null

Status codeDescription
200Returns the new project_score object
400The request was unacceptable, often due to missing a required parameter
401No valid API key provided
403The API key doesn’t have permissions to perform the request
429Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
500Something went wrong on Braintrust's end. (These are rare.)
curl -X POST "https://api.braintrust.dev/v1/project_score" \
  -d '{
  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  "name": "string",
  "description": "string",
  "score_type": "slider",
  "categories": [
    {
      "name": "string",
      "value": 0
    }
  ]
}'

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

{
  "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": "expected"
  },
  "position": "string"
}

PUT
/v1/project_score

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

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 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 | null

Textual description of the project score

score_type
Required
string

The type of the configured score

Value in: "slider" | "categorical" | "weighted" | "minimum" | null

categoriesAny properties in categorical, weighted, minimum, nullableVariant | null

Status codeDescription
200Returns the new project_score object
400The request was unacceptable, often due to missing a required parameter
401No valid API key provided
403The API key doesn’t have permissions to perform the request
429Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
500Something went wrong on Braintrust's end. (These are rare.)
curl -X PUT "https://api.braintrust.dev/v1/project_score" \
  -d '{
  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  "name": "string",
  "description": "string",
  "score_type": "slider",
  "categories": [
    {
      "name": "string",
      "value": 0
    }
  ]
}'

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

{
  "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": "expected"
  },
  "position": "string"
}

GET
/v1/project_score/{project_score_id}

Get project_score

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

project_score_id
Required
string

ProjectScore id

Format: "uuid"
Status codeDescription
200Returns the project_score object
400The request was unacceptable, often due to missing a required parameter
401No valid API key provided
403The API key doesn’t have permissions to perform the request
429Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
500Something went wrong on Braintrust's end. (These are rare.)
curl -X GET "https://api.braintrust.dev/v1/project_score/497f6eca-6276-4993-bfeb-53cbbbba6f08"

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

{
  "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": "expected"
  },
  "position": "string"
}

PATCH
/v1/project_score/{project_score_id}

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.

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

namestring | null

Name of the project score

descriptionstring | null

Textual description of the project score

score_typestring | null

The type of the configured score

Value in: "slider" | "categorical" | "weighted" | "minimum" | null

categoriesAny properties in categorical, weighted, minimum, nullableVariant | null

Path Parameters

project_score_id
Required
string

ProjectScore id

Format: "uuid"
Status codeDescription
200Returns the project_score object
400The request was unacceptable, often due to missing a required parameter
401No valid API key provided
403The API key doesn’t have permissions to perform the request
429Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
500Something went wrong on Braintrust's end. (These are rare.)
curl -X PATCH "https://api.braintrust.dev/v1/project_score/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -d '{
  "name": "string",
  "description": "string",
  "score_type": "slider",
  "categories": [
    {
      "name": "string",
      "value": 0
    }
  ]
}'

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

{
  "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": "expected"
  },
  "position": "string"
}

DELETE
/v1/project_score/{project_score_id}

Delete project_score

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

project_score_id
Required
string

ProjectScore id

Format: "uuid"
Status codeDescription
200Returns the deleted project_score object
400The request was unacceptable, often due to missing a required parameter
401No valid API key provided
403The API key doesn’t have permissions to perform the request
429Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
500Something went wrong on Braintrust's end. (These are rare.)
curl -X DELETE "https://api.braintrust.dev/v1/project_score/497f6eca-6276-4993-bfeb-53cbbbba6f08"

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

{
  "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": "expected"
  },
  "position": "string"
}

Previous

Projects

Next

Project Tags