BRbraintrustdata
SpanIframes

Create span iframe

Changed on

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

post/v1/span_iframe

Request

  • Base URL
    https://api.braintrust.dev
  • Auth
    • HTTP bearer
    • or none

Request body

project_idstring uuid required

Unique identifier for the project that the span iframe belongs under

namestring required

Name of the span iframe

descriptionstring nullable

Textual description of the span iframe

urlstring required

URL to embed the project viewer in an iframe

post_messageboolean nullable

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

idstring uuid required

Unique identifier for the span iframe

project_idstring uuid required

Unique identifier for the project that the span iframe belongs under

user_idstring uuid nullable

Identifies the user who created the span iframe

createdstring date-time nullable

Date of span iframe creation

deleted_atstring date-time nullable

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

namestring required

Name of the span iframe

descriptionstring nullable

Textual description of the span iframe

urlstring required

URL to embed the project viewer in an iframe

post_messageboolean nullable

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.

Changes