BRbraintrustdata
SpanIframes

Partially update span iframe

Changed on

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.

patch/v1/span_iframe/{span_iframe_id}

Request

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

Path parameters

span_iframe_idstring uuid required

SpanIframe id

Request body

namestring nullable

Name of the span iframe

urlstring nullable

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.

descriptionstring nullable

Textual description of the span iframe

Response

Returns the 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

  • 8f5039399f77Revision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

  • 77a2d5797d94Revision changes
    • info

      endpoint added