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

The Experiments API from Braintrust — 6 operation(s) for experiments.

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

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

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

10 operations 6 paths 38 schemas 1 DELETE4 GET1 PATCH4 POST

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 Experiments 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 10

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

Experiments 10
POST
/v1/experiment
Create experiment
postExperiment body → 200400401403429500
GET
/v1/experiment
List experiments
getExperiment 8 params → 200400401403429500
GET
/v1/experiment/{experiment_id}
Get experiment
getExperimentId 1 param → 200400401403429500
PATCH
/v1/experiment/{experiment_id}
Partially update experiment
patchExperimentId 1 param body → 200400401403429500
DELETE
/v1/experiment/{experiment_id}
Delete experiment
deleteExperimentId 1 param → 200400401403429500
POST
/v1/experiment/{experiment_id}/insert
Insert experiment events
postExperimentIdInsert 1 param body → 200400401403429500
POST
/v1/experiment/{experiment_id}/fetch
Fetch experiment (POST form)
postExperimentIdFetch 1 param body → 200400401403429500
GET
/v1/experiment/{experiment_id}/fetch
Fetch experiment (GET form)
getExperimentIdFetch 5 params → 200400401403429500
POST
/v1/experiment/{experiment_id}/feedback
Feedback for experiment events
postExperimentIdFeedback 1 param body → 200400401403429500
GET
/v1/experiment/{experiment_id}/summarize
Summarize experiment
getExperimentIdSummarize 3 params → 200400401403429500

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are ExperimentEvent (25 properties), InsertExperimentEvent (22 properties), Experiment (18 properties), CreateExperiment (14 properties). Each schema is shown below with its type and property counts.

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…
Experiment
object
18 properties 4 required
MaxXactId
string
DEPRECATION NOTICE: The manually-constructed pagination cursor is deprecated in favor of the explicit 'cursor' returned by object fetch requests. Please prefer…
FetchPaginationCursor
string
An opaque string to be used as a cursor for the next page of results, in order from latest to earliest. The string can be obtained directly from the cursor pro…
FetchEventsRequest
object
5 properties
ExperimentName
string
Name of the experiment to search for
FetchLimit
integer
limit the number of traces fetched Fetch queries may be paginated if the total result size is expected to be large (e.g. projectlogs which accumulate over a lo…
FeedbackExperimentEventRequest
object
1 property 1 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…
InsertEventsResponse
object
1 property 1 required
SummarizeExperimentResponse
object
Summary of an experiment
7 properties 4 required
ObjectReferenceNullish
object
Indicates the event was copied from another object.
5 properties 3 required
Ids
Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times
SpanAttributes
object
Human-identifying attributes of the span, such as name, type, etc.
3 properties
FetchExperimentEventsResponse
object
2 properties 1 required
InsertExperimentEventRequest
object
1 property 1 required
FetchLimitParam
integer
limit the number of traces fetched Fetch queries may be paginated if the total result size is expected to be large (e.g. projectlogs which accumulate over a lo…
FunctionTypeEnum
string
The type of global function. Defaults to 'scorer'.
RepoInfo
object
Metadata about the state of the repo when the experiment was created
9 properties
ComparisonExperimentId
string
The experiment to compare against, if summarizing scores and metrics. If omitted, will fall back to the baseexpid stored in the experiment metadata, and then t…
Version
string
Retrieve a snapshot of events from a past time The version id is essentially a filter on the latest event transaction id. You can use the maxxactid returned by…
ProjectName
string
Name of the project to search for
PatchExperiment
object
12 properties
ScoreSummary
object
Summary of a score's performance
5 properties 4 required
ExperimentEvent
object
25 properties 7 required
FeedbackExperimentItem
object
7 properties 1 required
AppLimitWithDefaultParam
integer
Limit the number of objects to return
CreateExperiment
object
14 properties 1 required
MetricSummary
object
Summary of a metric's performance
6 properties 5 required
FeedbackResponseSchema
object
1 property 1 required
InsertExperimentEvent
object
An experiment event
22 properties
SummarizeScores
boolean
Whether to summarize the scores and metrics. If false (or omitted), only the metadata will be returned.
SavedFunctionId
Optional function identifier that produced the classification
MaxRootSpanId
string
DEPRECATION NOTICE: The manually-constructed pagination cursor is deprecated in favor of the explicit 'cursor' returned by object fetch requests. Please prefer…
SpanType
string
Type of the span, for display purposes only
ProjectIdQuery
string
Project id
ExperimentIdParam
string
Experiment id

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

braintrust-experiments-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 Functions API
Where this information came from

This is an independent, third-party profile of Braintrust Experiments 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.