Reference/API/Span Iframes

List span_iframes

List out all span_iframes. The span_iframes are sorted by creation date, with the most recently-created span_iframes coming first

GET
/v1/span_iframe

Authorization

Authorization
Required
Bearer <token>

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.

In: header

Query Parameters

limitinteger

Limit the number of objects to return

Minimum: 0
starting_afterstring

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

Format: "uuid"
ending_beforestring

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

Format: "uuid"
idsAny properties in string, array<string>

Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times

span_iframe_namestring

Name of the span_iframe to search for

org_namestring

Filter search results to within a particular organization

curl -X GET "https://api.braintrust.dev/v1/span_iframe?limit=0&starting_after=497f6eca-6276-4993-bfeb-53cbbbba6f08&ending_before=497f6eca-6276-4993-bfeb-53cbbbba6f08&ids=497f6eca-6276-4993-bfeb-53cbbbba6f08&span_iframe_name=string&org_name=string" \
  -H "Authorization: Bearer <token>"

Returns a list of span_iframe objects

{
  "objects": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
      "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
      "created": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "description": "string",
      "url": "string",
      "post_message": true
    }
  ]
}

Create span_iframe

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

Authorization

Authorization
Required
Bearer <token>

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.

In: header

Request Body

application/jsonOptional

Any desired information about the new span_iframe object

project_id
Required
string

Unique identifier for the project that the span iframe belongs under

Format: "uuid"
name
Required
string

Name of the span iframe

descriptionstring

Textual description of the span iframe

url
Required
string

URL to embed the project viewer in an iframe

post_messageboolean

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.

curl -X POST "https://api.braintrust.dev/v1/span_iframe" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
    "name": "string",
    "description": "string",
    "url": "string",
    "post_message": true
  }'

Returns the new span_iframe object

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "created": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "url": "string",
  "post_message": true
}

Create or replace span_iframe

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

PUT
/v1/span_iframe

Authorization

Authorization
Required
Bearer <token>

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.

In: header

Request Body

application/jsonOptional

Any desired information about the new span_iframe object

project_id
Required
string

Unique identifier for the project that the span iframe belongs under

Format: "uuid"
name
Required
string

Name of the span iframe

descriptionstring

Textual description of the span iframe

url
Required
string

URL to embed the project viewer in an iframe

post_messageboolean

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.

curl -X PUT "https://api.braintrust.dev/v1/span_iframe" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
    "name": "string",
    "description": "string",
    "url": "string",
    "post_message": true
  }'

Returns the new span_iframe object

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "created": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "url": "string",
  "post_message": true
}

Get span_iframe

Get a span_iframe object by its id

GET
/v1/span_iframe/{span_iframe_id}

Authorization

Authorization
Required
Bearer <token>

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.

In: header

Path Parameters

span_iframe_id
Required
string

SpanIframe id

Format: "uuid"
curl -X GET "https://api.braintrust.dev/v1/span_iframe/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer <token>"

Returns the span_iframe object

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "created": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "url": "string",
  "post_message": true
}

Partially update span_iframe

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}

Authorization

Authorization
Required
Bearer <token>

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.

In: header

Request Body

application/jsonOptional

Fields to update

namestring

Name of the span iframe

urlstring

URL to embed the project viewer in an iframe

post_messageboolean

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

Textual description of the span iframe

Path Parameters

span_iframe_id
Required
string

SpanIframe id

Format: "uuid"
curl -X PATCH "https://api.braintrust.dev/v1/span_iframe/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "url": "string",
    "post_message": true,
    "description": "string"
  }'

Returns the span_iframe object

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "created": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "url": "string",
  "post_message": true
}

Delete span_iframe

Delete a span_iframe object by its id

DELETE
/v1/span_iframe/{span_iframe_id}

Authorization

Authorization
Required
Bearer <token>

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.

In: header

Path Parameters

span_iframe_id
Required
string

SpanIframe id

Format: "uuid"
curl -X DELETE "https://api.braintrust.dev/v1/span_iframe/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer <token>"

Returns the deleted span_iframe object

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "created": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "url": "string",
  "post_message": true
}

On this page