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 Prompts API

The Prompts API from Braintrust — 2 operation(s) for prompts.

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

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

This API exposes 6 operations across 2 paths, and defines 34 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.

6 operations 2 paths 34 schemas 1 DELETE2 GET1 PATCH1 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 Prompts 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 6

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

Prompts 6
POST
/v1/prompt
Create prompt
postPrompt body → 200400401403429500
PUT
/v1/prompt
Create or replace prompt
putPrompt body → 200400401403429500
GET
/v1/prompt
List prompts
getPrompt 11 params → 200400401403429500
GET
/v1/prompt/{prompt_id}
Get prompt
getPromptId 3 params → 200400401403429500
PATCH
/v1/prompt/{prompt_id}
Partially update prompt
patchPromptId 1 param body → 200400401403429500
DELETE
/v1/prompt/{prompt_id}
Delete prompt
deletePromptId 1 param → 200400401403429500

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are Prompt (13 properties), CreatePrompt (7 properties), PromptDataNullish (7 properties), PatchPrompt (5 properties). Each schema is shown below with its type and property counts.

PromptIdParam
string
Prompt id
OrgName
string
Filter search results to within a particular organization
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…
ChatCompletionContentPartText
object
3 properties 1 required
ChatCompletionContentPartFileWithTitle
object
2 properties 2 required
FunctionTypeEnumNullish
string
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
PromptParserNullish
object
5 properties 2 required
PromptBlockDataNullish
Ids
Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times
ChatCompletionContentPartFileFile
object
3 properties
ChatCompletionMessageToolCall
object
3 properties 3 required
ChatCompletionMessageParam
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
ResponseFormatJsonSchema
object
4 properties 1 required
FunctionTypeEnum
string
The type of global function. Defaults to 'scorer'.
AppLimitParam
integer
Limit the number of objects to return
ProjectName
string
Name of the project to search for
CreatePrompt
object
7 properties 3 required
ChatCompletionContentPart
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…
ChatCompletionContentPartTextWithTitle
object
3 properties 1 required
PromptOptionsNullish
object
3 properties
PromptDataNullish
object
The prompt, model, and its parameters
7 properties
SavedFunctionId
Optional function identifier that produced the classification
PromptName
string
Name of the prompt to search for
Prompt
object
13 properties 7 required
PatchPrompt
object
5 properties
ChatCompletionContentPartImageWithTitle
object
2 properties 2 required
ProjectIdQuery
string
Project id
ResponseFormatNullish
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…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

braintrust-prompts-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 Prompts 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.