How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Braintrust Functions API

The Functions API from Braintrust — 3 operation(s) for functions.

Braintrust Functions API is one of 41 APIs that Braintrust publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Functions. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 3 paths, and defines 51 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.braintrust.dev.

7 operations 3 paths 51 schemas 1 DELETE2 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.braintrust.dev
Authentication
HTTP Bearer
License
Apache 2.0
Resource Areas
1

Authentication & Security 1

Braintrust Functions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API key or JWT) (bearerAuth). By default, every request must be authenticated, though some operations may also be called without credentials.

  • bearerAuth — Most Braintrust endpoints are authenticated by providing your API key as a header Authorization: Bearer [apikey] to your HTTP request. You can create an API ke…

Paths & Operations 7

Across 3 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Functions 7
POST
/v1/function
Create function
postFunction body → 200400401403429500
PUT
/v1/function
Create or replace function
putFunction body → 200400401403429500
GET
/v1/function
List functions
getFunction 11 params → 200400401403429500
GET
/v1/function/{function_id}
Get function
getFunctionId 3 params → 200400401403429500
PATCH
/v1/function/{function_id}
Partially update function
patchFunctionId 1 param body → 200400401403429500
DELETE
/v1/function/{function_id}
Delete function
deleteFunctionId 1 param → 200400401403429500
POST
/v1/function/{function_id}/invoke
Invoke function
postFunctionIdInvoke 1 param body → 200

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are Function (16 properties), InvokeApi (12 properties), CreateFunction (10 properties), TopicMapData (9 properties). Each schema is shown below with its type and property counts.

CreateFunction
object
10 properties 4 required
OrgName
string
Filter search results to within a particular organization
ChatCompletionContentPartText
object
3 properties 1 required
StartingAfter
string
Pagination cursor id. For example, if the final item in the last page you fetched had an id of foo, pass startingafter=foo to fetch the next page. Note: you ma…
ChatCompletionContentPartFileWithTitle
object
2 properties 2 required
FunctionTypeEnumNullish
string
GraphData
object
This feature is preliminary and unsupported.
3 properties 3 required
PromptBlockData
GraphEdge
object
3 properties 3 required
EndingBefore
string
Pagination cursor id. For example, if the initial item in the last page you fetched had an id of foo, pass endingbefore=foo to fetch the previous page. Note: y…
Slug
string
Retrieve prompt with a specific slug
BatchedFacetData
object
4 properties 2 required
FunctionDataNullish
PromptParserNullish
object
5 properties 2 required
InvokeParent
Options for tracing the function call
PromptBlockDataNullish
ChatCompletionMessageToolCall
object
3 properties 3 required
ChatCompletionContentPartFileFile
object
3 properties
Ids
Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times
TopicMapGenerationSettings
object
Clustering and naming settings used to generate this topic map
8 properties 2 required
ChatCompletionMessageParam
GraphNode
ChatCompletionMessageReasoning
object
Note: This is not part of the OpenAI API spec, but we added it for interoperability with multiple reasoning models.
2 properties
ModelParams
FunctionIdParam
string
Function id
FunctionName
string
Name of the function to search for
PatchFunction
object
5 properties
ResponseFormatJsonSchema
object
4 properties 1 required
FunctionTypeEnum
string
The type of global function. Defaults to 'scorer'.
FunctionData
PromptEnvironment
string
Filter by environment slug. Cannot be used together with version. For GET /v1/prompt, environment resolution currently requires the request to match a single p…
AppLimitParam
integer
Limit the number of objects to return
ProjectName
string
Name of the project to search for
ChatCompletionContentPart
FunctionIdRef
object
Options for identifying a function
StreamingMode
string
The mode format of the returned value (defaults to 'auto')
PromptVersion
string
Retrieve prompt at a specific version. The version id can either be a transaction id (e.g. '1000192656880881099') or a version identifier (e.g. '81cd05ee665fdf…
PromptOptionsNullish
object
3 properties
TopicMapData
object
9 properties 3 required
NullableSavedFunctionId
Default preprocessor for this project. When set, functions that use preprocessors will use this instead of their built-in default.
AclObjectType
string
The object type that the ACL applies to
InvokeApi
object
The request to invoke a function
12 properties
Function
object
16 properties 8 required
PromptDataNullish
object
The prompt, model, and its parameters
7 properties
SavedFunctionId
Optional function identifier that produced the classification
CodeBundle
object
4 properties 2 required
ChatCompletionContentPartImageWithTitle
object
2 properties 2 required
ProjectIdQuery
string
Project id
FacetData
object
6 properties 2 required
ResponseFormatNullish
ChatCompletionContentPartTextWithTitle
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

braintrust-functions-api-openapi.yml Raw ↑

Other APIs Braintrust publishes across the network.

Braintrust API
Braintrust Acls API
Braintrust AiSecrets API
Braintrust ApiKeys API
Braintrust CORS API
Braintrust CrossObject API
Braintrust Datasets API
Braintrust DatasetSnapshots API
Braintrust Environments API
Braintrust EnvVars API
Braintrust Evals API
Braintrust Experiments API
Where this information came from

This is an independent, third-party profile of Braintrust Functions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.