Skip to main content
PUT
/
v1
/
span_iframe
Create or replace span_iframe
curl --request PUT \
  --url https://api.braintrust.dev/v1/span_iframe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "url": "<string>",
  "description": "<string>",
  "post_message": true
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "url": "<string>",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "post_message": true
}

Authorizations

​
Authorization
string
header
required

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.

Body

application/json

Any desired information about the new span_iframe object

​
project_id
string<uuid>
required

Unique identifier for the project that the span iframe belongs under

​
name
string
required

Name of the span iframe

​
url
string
required

URL to embed the project viewer in an iframe

​
description
string | null

Textual description of the span iframe

​
post_message
boolean | null

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.

Response

Returns the new span_iframe object

​
id
string<uuid>
required

Unique identifier for the span iframe

​
project_id
string<uuid>
required

Unique identifier for the project that the span iframe belongs under

​
name
string
required

Name of the span iframe

​
url
string
required

URL to embed the project viewer in an iframe

​
user_id
string<uuid> | null

Identifies the user who created the span iframe

​
created
string<date-time> | null

Date of span iframe creation

​
deleted_at
string<date-time> | null

Date of span iframe deletion, or null if the span iframe is still active

​
description
string | null

Textual description of the span iframe

​
post_message
boolean | null

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.