List functions
List out all functions. The functions are sorted by creation date, with the most recently-created functions 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
function_name
stringName of the function to search for
project_name
stringName of the project to search for
project_id
stringProject id
"uuid"
slug
stringRetrieve prompt with a specific slug
version
stringRetrieve prompt at a specific version.
The version id can either be a transaction id (e.g. '1000192656880881099') or a version identifier (e.g. '81cd05ee665fdfb3').
org_name
stringFilter search results to within a particular organization
Returns a list of function objects
Create function
Create a new function. If there is an existing function in the project with the same slug as the one specified in the request, will return the existing function 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 function object
project_id
Unique identifier for the project that the prompt belongs under
"uuid"
name
Name of the prompt
1
slug
Unique identifier for the prompt
1
description
stringTextual description of the prompt
prompt_data
objectThe prompt, model, and its parameters
tags
array<string>A list of tags for the prompt
function_type
string"llm" | "scorer" | "task" | "tool" | null
function_data
origin
objectfunction_schema
objectJSON schema for the function's parameters and return type
Returns the new function object
Create or replace function
Create or replace function. If there is an existing function in the project with the same slug as the one specified in the request, will replace the existing function 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 function object
project_id
Unique identifier for the project that the prompt belongs under
"uuid"
name
Name of the prompt
1
slug
Unique identifier for the prompt
1
description
stringTextual description of the prompt
prompt_data
objectThe prompt, model, and its parameters
tags
array<string>A list of tags for the prompt
function_type
string"llm" | "scorer" | "task" | "tool" | null
function_data
origin
objectfunction_schema
objectJSON schema for the function's parameters and return type
Returns the new function object
Get function
Get a function 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
function_id
Function id
"uuid"
Query Parameters
version
stringRetrieve prompt at a specific version.
The version id can either be a transaction id (e.g. '1000192656880881099') or a version identifier (e.g. '81cd05ee665fdfb3').
Returns the function object
Partially update function
Partially update a function 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 prompt
description
stringTextual description of the prompt
prompt_data
objectThe prompt, model, and its parameters
function_data
Any properties in prompt, code, globaltags
array<string>A list of tags for the prompt
Path Parameters
function_id
Function id
"uuid"
Returns the function object
Delete function
Delete a function 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
function_id
Function id
"uuid"
Returns the deleted function object
Invoke function
Invoke a function.
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
OptionalFunction invocation parameters
input
unknownArgument to the function, which can be any JSON serializable value
expected
unknownThe expected output of the function
metadata
objectAny relevant metadata
messages
array<Any properties in system, user, assistant, tool, function, fallback>If the function is an LLM, additional messages to pass along to it
parent
Any properties in span_parent_struct, stringOptions for tracing the function call
stream
booleanWhether to stream the response. If true, results will be returned in the Braintrust SSE format.
mode
stringThe mode format of the returned value (defaults to 'auto')
"auto" | "parallel" | null
version
stringThe version of the function
Path Parameters
function_id
Function id
"uuid"
Function invocation response