Skip to main content
POST
Error

Authorizations

X-API-Key
string
header
required

Path Parameters

name
string
required

Browser name or ID

attachment_id
string
required

Attachment ID

Body

application/json
embed_origins
string[]

EmbedOrigins are the origins whose pages may show the window's pages in an iframe, such as https://app.example.com: https, or http on localhost, with no path. Without them no page may frame the window.

Maximum array length: 5
ttl_seconds
integer

TTLSeconds is how long the links work, from 60 seconds to 24 hours. Defaults to 24 hours.

Required range: 60 <= x <= 86400

Response

OK

act_url
string

ActURL also lets the person take control of the window, use it, and hand it back.

expires_at
string<date-time>
view_url
string

ViewURL shows the window and takes no input.