/browser/*/live
POST/browser/*/live
Creates a live URL (view-only by default; pass interactable: true for a link a person can act through) for a currently-running browser, identified by browserId. Hosted authenticated Cloud plans, including Free, can use this route. Explicitly disabled and unlicensed deployments remain ineligible.
Request
Body
- Schema
- Example (auto)
- LiveURLInstructions
- string
Page targetId from GET /browser/{id}/pages. Defaults to the focused tab. May name a tab in any browser context.
tab stays on this tab (default with targetId); follow jumps to new tabs and popups (default without).
Possible values: [follow, tab]
Independent viewer transport; request browser keep-alive separately. Defaults to false.
Allow the viewer to click and type. Defaults to false.
Link lifetime in milliseconds, capped at 15 minutes, the plan maximum, and remaining session time.
Integer image quality from 1 to 100. Defaults to 70.
Image format. Defaults to jpeg; png only accepts explicit quality 100.
Possible values: [jpeg, png]
Allow the viewer to resize the browser. Defaults to false.
Show the browser interface. Defaults to true, or false when targetId is set.
Show a countdown with a warning tooltip during the final 60 seconds. Defaults to false.
instructions object
Plain text or a structured instructions card shown to the human viewer.
Possible values: [modal, panel]
Possible values: [markdown, text]
Card title, at most 80 characters. Use instructions.title with an object.
Up to 10 non-empty steps of at most 300 characters. Use instructions.steps with an object.
Current step, from 1 through the number of steps. Use instructions.currentStep with an object.
Done button label, at most 40 characters.
Failure button label, at most 40 characters.
Requester name, at most 60 characters.
Inline formatting, defaults to text. Use instructions.format with an object.
Possible values: [markdown, text]
{
"targetId": "string",
"mode": "follow",
"detached": true,
"interactable": true,
"fileUpload": true,
"timeout": 0,
"quality": 0,
"type": "jpeg",
"resizable": true,
"showBrowserInterface": true,
"showTimer": true,
"instructions": {
"layout": "modal",
"format": "markdown",
"title": "string",
"summary": "string",
"steps": [
"string"
],
"currentStep": 0
},
"instructionsTitle": "string",
"steps": [
"string"
],
"currentStep": 0,
"doneLabel": "string",
"failLabel": "string",
"requesterName": "string",
"instructionsFormat": "markdown"
}
Responses
- 200
- 400
- 401
- 403
- 404
- 408
- 429
- 500
- 503
Schema
- Fields
- Example (auto)
URL the viewer opens to watch or interact with the browser.
Identifier used to check or close this live URL.
Applied link lifetime in milliseconds.
Enforced session deadline in epoch milliseconds, or null if unbounded.
The page this live URL streams.
{
"liveURL": "string",
"liveURLId": "string",
"timeout": 0,
"browserExpiresAt": 0,
"targetId": "string"
}
The request contains errors or didn't properly encode content.
The request is missing, or contains bad, authorization credentials.
The request targets a destination that is not allowed.
Resource couldn't be found.
The request took has taken too long to process.
Too many requests are currently being processed.
An internal error occurred when handling the request.
Service is unavailable.