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
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
limit
integerLimit the number of objects to return
0
starting_after
stringPagination 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
"uuid"
ending_before
stringPagination 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
"uuid"
ids
Any 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_name
stringName of the project_score to search for
project_name
stringName of the project to search for
project_id
stringProject id
"uuid"
org_name
stringFilter search results to within a particular organization
score_type
Any properties in project_score_type_single, array<project_score_type_single & project_score_type>Returns a list of project_score objects
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
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/json
OptionalAny desired information about the new project_score object
project_id
Unique identifier for the project that the project score belongs under
"uuid"
name
Name of the project score
description
stringTextual description of the project score
score_type
The type of the configured score
"slider" | "categorical" | "weighted" | "minimum" | "maximum" | "online" | "free-form"
categories
Any properties in categorical, weighted, minimumconfig
objectReturns the new project_score object
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
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/json
OptionalAny desired information about the new project_score object
project_id
Unique identifier for the project that the project score belongs under
"uuid"
name
Name of the project score
description
stringTextual description of the project score
score_type
The type of the configured score
"slider" | "categorical" | "weighted" | "minimum" | "maximum" | "online" | "free-form"
categories
Any properties in categorical, weighted, minimumconfig
objectReturns the new project_score object
Get project_score
Get a project_score object by its id
Authorization
Authorization
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
ProjectScore id
"uuid"
Returns the project_score object
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
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/json
OptionalFields to update
name
stringName of the project score
description
stringTextual description of the project score
score_type
project_score_type_singleThe type of the configured score
"slider" | "categorical" | "weighted" | "minimum" | "maximum" | "online" | "free-form"
categories
Any properties in categorical, weighted, minimumconfig
objectPath Parameters
project_score_id
ProjectScore id
"uuid"
Returns the project_score object
Delete project_score
Delete a project_score object by its id
Authorization
Authorization
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
ProjectScore id
"uuid"
Returns the deleted project_score object