Braintrust SpanIframes API
The SpanIframes API from Braintrust — 2 operation(s) for spaniframes.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/braintrust-spaniframes-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
version: 1.0.0
title: Braintrust Acls Span Iframes API
description: 'API specification for the backend data server. The API is hosted globally at
https://api.braintrust.dev or in your own environment.
You can access the OpenAPI spec for this API at https://github.com/braintrustdata/braintrust-openapi.'
license:
name: Apache 2.0
servers:
- url: https://api.braintrust.dev
security:
- bearerAuth: []
- {}
tags:
- name: SpanIframes
paths:
/v1/span_iframe:
post:
tags:
- SpanIframes
security:
- bearerAuth: []
- {}
operationId: postSpanIframe
description: Create a new span_iframe. If there is an existing span_iframe with the same name as the one specified in the request, will return the existing span_iframe unmodified
summary: Create span_iframe
requestBody:
description: Any desired information about the new span_iframe object
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSpanIFrame'
responses:
'200':
description: Returns the new span_iframe object
content:
application/json:
schema:
$ref: '#/components/schemas/SpanIFrame'
'400':
description: The request was unacceptable, often due to missing a required parameter
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'401':
description: No valid API key provided
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'403':
description: The API key doesn’t have permissions to perform the request
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'429':
description: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
headers:
Retry-After:
schema:
type: string
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'500':
description: Something went wrong on Braintrust's end. (These are rare.)
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
put:
tags:
- SpanIframes
security:
- bearerAuth: []
- {}
operationId: putSpanIframe
description: Create or replace span_iframe. If there is an existing span_iframe with the same name as the one specified in the request, will replace the existing span_iframe with the provided fields
summary: Create or replace span_iframe
requestBody:
description: Any desired information about the new span_iframe object
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSpanIFrame'
responses:
'200':
description: Returns the new span_iframe object
content:
application/json:
schema:
$ref: '#/components/schemas/SpanIFrame'
'400':
description: The request was unacceptable, often due to missing a required parameter
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'401':
description: No valid API key provided
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'403':
description: The API key doesn’t have permissions to perform the request
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'429':
description: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
headers:
Retry-After:
schema:
type: string
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'500':
description: Something went wrong on Braintrust's end. (These are rare.)
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
get:
operationId: getSpanIframe
tags:
- SpanIframes
description: List out all span_iframes. The span_iframes are sorted by creation date, with the most recently-created span_iframes coming first
summary: List span_iframes
security:
- bearerAuth: []
- {}
parameters:
- $ref: '#/components/parameters/AppLimitParam'
- $ref: '#/components/parameters/StartingAfter'
- $ref: '#/components/parameters/EndingBefore'
- $ref: '#/components/parameters/Ids'
- $ref: '#/components/parameters/SpanIframeName'
- $ref: '#/components/parameters/OrgName'
responses:
'200':
description: Returns a list of span_iframe objects
content:
application/json:
schema:
type: object
properties:
objects:
type: array
items:
$ref: '#/components/schemas/SpanIFrame'
description: A list of span_iframe objects
required:
- objects
additionalProperties: false
'400':
description: The request was unacceptable, often due to missing a required parameter
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'401':
description: No valid API key provided
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'403':
description: The API key doesn’t have permissions to perform the request
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'429':
description: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
headers:
Retry-After:
schema:
type: string
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'500':
description: Something went wrong on Braintrust's end. (These are rare.)
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
/v1/span_iframe/{span_iframe_id}:
get:
operationId: getSpanIframeId
tags:
- SpanIframes
description: Get a span_iframe object by its id
summary: Get span_iframe
security:
- bearerAuth: []
- {}
parameters:
- $ref: '#/components/parameters/SpanIframeIdParam'
responses:
'200':
description: Returns the span_iframe object
content:
application/json:
schema:
$ref: '#/components/schemas/SpanIFrame'
'400':
description: The request was unacceptable, often due to missing a required parameter
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'401':
description: No valid API key provided
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'403':
description: The API key doesn’t have permissions to perform the request
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'429':
description: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
headers:
Retry-After:
schema:
type: string
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'500':
description: Something went wrong on Braintrust's end. (These are rare.)
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
patch:
operationId: patchSpanIframeId
tags:
- SpanIframes
description: Partially update a span_iframe 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.
summary: Partially update span_iframe
security:
- bearerAuth: []
- {}
parameters:
- $ref: '#/components/parameters/SpanIframeIdParam'
requestBody:
description: Fields to update
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/PatchSpanIFrame'
responses:
'200':
description: Returns the span_iframe object
content:
application/json:
schema:
$ref: '#/components/schemas/SpanIFrame'
'400':
description: The request was unacceptable, often due to missing a required parameter
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'401':
description: No valid API key provided
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'403':
description: The API key doesn’t have permissions to perform the request
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'429':
description: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
headers:
Retry-After:
schema:
type: string
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'500':
description: Something went wrong on Braintrust's end. (These are rare.)
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
delete:
operationId: deleteSpanIframeId
tags:
- SpanIframes
description: Delete a span_iframe object by its id
summary: Delete span_iframe
security:
- bearerAuth: []
- {}
parameters:
- $ref: '#/components/parameters/SpanIframeIdParam'
responses:
'200':
description: Returns the deleted span_iframe object
content:
application/json:
schema:
$ref: '#/components/schemas/SpanIFrame'
'400':
description: The request was unacceptable, often due to missing a required parameter
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'401':
description: No valid API key provided
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'403':
description: The API key doesn’t have permissions to perform the request
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'429':
description: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
headers:
Retry-After:
schema:
type: string
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
'500':
description: Something went wrong on Braintrust's end. (These are rare.)
content:
text/plain:
schema:
type: string
application/json:
schema:
nullable: true
components:
schemas:
Ids:
anyOf:
- type: string
format: uuid
- type: array
items:
type: string
format: uuid
description: Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times
OrgName:
type: string
description: Filter search results to within a particular organization
StartingAfter:
type: string
format: uuid
description: 'Pagination 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`'
PatchSpanIFrame:
type: object
properties:
name:
type: string
nullable: true
description: Name of the span iframe
url:
type: string
nullable: true
description: URL to embed the project viewer in an iframe
post_message:
type: boolean
nullable: true
description: Whether to post messages to the iframe containing the span's data. This is useful when you want to render more data than fits in the URL.
description:
type: string
nullable: true
description: Textual description of the span iframe
AppLimitParam:
type: integer
nullable: true
minimum: 0
description: Limit the number of objects to return
SpanIFrame:
type: object
properties:
id:
type: string
format: uuid
description: Unique identifier for the span iframe
project_id:
type: string
format: uuid
description: Unique identifier for the project that the span iframe belongs under
user_id:
type: string
nullable: true
format: uuid
description: Identifies the user who created the span iframe
created:
type: string
nullable: true
format: date-time
description: Date of span iframe creation
deleted_at:
type: string
nullable: true
format: date-time
description: Date of span iframe deletion, or null if the span iframe is still active
name:
type: string
description: Name of the span iframe
description:
type: string
nullable: true
description: Textual description of the span iframe
url:
type: string
description: URL to embed the project viewer in an iframe
post_message:
type: boolean
nullable: true
description: Whether to post messages to the iframe containing the span's data. This is useful when you want to render more data than fits in the URL.
required:
- id
- project_id
- name
- url
SpanIframeIdParam:
type: string
format: uuid
description: SpanIframe id
EndingBefore:
type: string
format: uuid
description: 'Pagination 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`'
CreateSpanIFrame:
type: object
properties:
project_id:
type: string
format: uuid
description: Unique identifier for the project that the span iframe belongs under
name:
type: string
description: Name of the span iframe
description:
type: string
nullable: true
description: Textual description of the span iframe
url:
type: string
description: URL to embed the project viewer in an iframe
post_message:
type: boolean
nullable: true
description: Whether to post messages to the iframe containing the span's data. This is useful when you want to render more data than fits in the URL.
required:
- project_id
- name
- url
SpanIframeName:
type: string
description: Name of the span_iframe to search for
parameters:
OrgName:
schema:
$ref: '#/components/schemas/OrgName'
required: false
description: Filter search results to within a particular organization
name: org_name
in: query
allowReserved: true
SpanIframeIdParam:
schema:
$ref: '#/components/schemas/SpanIframeIdParam'
required: true
description: SpanIframe id
name: span_iframe_id
in: path
StartingAfter:
schema:
$ref: '#/components/schemas/StartingAfter'
required: false
description: 'Pagination 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`'
name: starting_after
in: query
Ids:
schema:
$ref: '#/components/schemas/Ids'
required: false
description: Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times
name: ids
in: query
AppLimitParam:
schema:
$ref: '#/components/schemas/AppLimitParam'
required: false
description: Limit the number of objects to return
name: limit
in: query
SpanIframeName:
schema:
$ref: '#/components/schemas/SpanIframeName'
required: false
description: Name of the span_iframe to search for
name: span_iframe_name
in: query
allowReserved: true
EndingBefore:
schema:
$ref: '#/components/schemas/EndingBefore'
required: false
description: 'Pagination 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`'
name: ending_before
in: query
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: API key or JWT
description: '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](https://www.braintrustdata.com/app/settings?subroute=api-keys).'