Error

A valid request URL is required to generate request examples

{
  "act_embed_url": "<string>",
  "act_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "view_embed_url": "<string>",
  "view_url": "<string>"
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

Create links to a browser window (Beta)

Beta: mint a view link and an act link for one window, as every attachment response does, with a chosen lifetime and the origins allowed to embed the window’s pages in an iframe. Without embed_origins no page may frame them. view_embed_url and act_embed_url carry the same tokens in the URL fragment, for an iframe, so no server sees them. An embedded page sends its parent window messages when control changes and when it connects or disconnects (see the browser guide). Either link opens the window to anyone who holds it until it expires; detaching the window ends it early. A stopped browser starts when links are minted and when a link is opened, and resumes with its windows. Minting takes being the browser’s creator or a role with sandboxes:exec.

POST

/

api

/

v2

/

sandboxes

/

browsers

/

{name}

/

attachments

/

{attachment_id}

/

links

Error

A valid request URL is required to generate request examples

{
  "act_embed_url": "<string>",
  "act_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "view_embed_url": "<string>",
  "view_url": "<string>"
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

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_embed_url

string

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_embed_url

string

ViewEmbedURL and ActEmbedURL open the same window in an iframe with the token in the URL fragment, which no server, log or Referer header sees. Viewer options follow the token in the fragment, as in {act_embed_url}&fit=follow&zoom=1.

view_url

string

ViewURL shows the window and takes no input.