Skip to content

packageStudioBridge

POST
/api/v1/packages/{packageId}/studio/bridge
curl --request POST \
--url https://example.com/api/v1/packages/example/studio/bridge \
--header 'Content-Type: application/json' \
--cookie tilecast_session=<tilecast_session> \
--data '{ "input": "example" }'

Invoke one Studio UI call in the package guest: the Studio parent carries the dashboard session and CSRF token the sandboxed frame cannot hold, and the host runs the package handle_ui_request export with a five-second timeout. The input is base64 over the 16 KiB call window. A successful invocation always answers 200 with the guest status code and base64 output; only transport and host failures become errors. Owner and Administrator only, like every package operation.

packageId
required
string
/^[a-z][a-z0-9_.:-]{0,127}$/

Store package identifier such as countdown_bar.

Media typeapplication/json
object
input
required

Base64 call payload, at most 16 KiB decoded.

string format: byte
Examplegenerated
{
"input": "example"
}

Guest answer

Media typeapplication/json
object
data
required
object
status
required

Guest status code; negative values are guest errors.

integer
output
required

Base64 guest output, at most 16 KiB.

string format: byte
Examplegenerated
{
"data": {
"status": 1,
"output": "example"
}
}

Invalid_bridge_input

Dashboard authentication required

Package_studio_unavailable