Open the live view
An HTML page showing the session's browser, with tabs and input (a person can click and type in it). Open the session's liveUrl; framing is allowed only on the platform's own front ends. A session created with browser: false has no live view (liveUrl is null; the page answers 409 browser_disabled, and so does its socket).
GET
/live/{id}Request
| Method and path | GET/live/{id} |
|---|---|
| Base URL | https://api.boxline.dev |
| Authentication | The signed token in the session’s URL. Anyone with the URL can use it, so treat it like a password. |
Path parameters
| Name | Type | Default | Allowed values | Description |
|---|---|---|---|---|
idrequired | string | – | – |
# Get a fresh liveUrl, then open it in a browser.curl "https://api.boxline.dev/v1/sessions/$SESSION_ID" \ -H "x-api-key: $BOXLINE_API_KEY" | jq -r .liveUrlimport { Boxline } from "@boxline/sdk";const bx = new Boxline(); // reads BOXLINE_API_KEY and BOXLINE_API_URLconst session = await bx.sessions.get("SESSION_ID");console.log("Open this link in a browser:", session.liveUrl);from boxline import Boxlinebx = Boxline() # reads BOXLINE_API_KEY and BOXLINE_API_URLsession = bx.sessions.get("SESSION_ID")print("Open this link in a browser:", session.live_url)boxline sessions live $SESSION_ID # prints the link to openResponses
200 OK
The page.
text/html: An HTML page.
An HTML pageErrors
Errors have a matching HTTP status and the same body. code is stable, so check it in your code; message is for people. See Errors and request ids.
| Status | Codes | When |
|---|---|---|
| 401 Unauthorized | Missing, expired or revoked token (plain text). |
{ "error": { "code": "not_found", "message": "session not found", "requestId": "req_4fJx0aQm2Lk9Pz7N" }}Learn more
These docs describe a beta API. Endpoints, fields and SDK methods may change before general availability; breaking changes will be listed in the changelog.