For AI agents: a documentation index is available at /llms.txt
Skip to main content

/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

    targetIdstring

    Page targetId from GET /browser/{id}/pages. Defaults to the focused tab. May name a tab in any browser context.

    modestring

    tab stays on this tab (default with targetId); follow jumps to new tabs and popups (default without).

    Possible values: [follow, tab]

    detachedboolean

    Independent viewer transport; request browser keep-alive separately. Defaults to false.

    interactableboolean

    Allow the viewer to click and type. Defaults to false.

    fileUploadboolean
    timeoutnumber

    Link lifetime in milliseconds, capped at 15 minutes, the plan maximum, and remaining session time.

    qualitynumber

    Integer image quality from 1 to 100. Defaults to 70.

    typestring

    Image format. Defaults to jpeg; png only accepts explicit quality 100.

    Possible values: [jpeg, png]

    resizableboolean

    Allow the viewer to resize the browser. Defaults to false.

    showBrowserInterfaceboolean

    Show the browser interface. Defaults to true, or false when targetId is set.

    showTimerboolean

    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.

    anyOf
    layoutstring

    Possible values: [modal, panel]

    formatstring

    Possible values: [markdown, text]

    titlestring
    summarystring
    stepsstring[]
    currentStepnumber
    instructionsTitlestring

    Card title, at most 80 characters. Use instructions.title with an object.

    stepsstring[]

    Up to 10 non-empty steps of at most 300 characters. Use instructions.steps with an object.

    currentStepnumber

    Current step, from 1 through the number of steps. Use instructions.currentStep with an object.

    doneLabelstring

    Done button label, at most 40 characters.

    failLabelstring

    Failure button label, at most 40 characters.

    requesterNamestring

    Requester name, at most 60 characters.

    instructionsFormatstring

    Inline formatting, defaults to text. Use instructions.format with an object.

    Possible values: [markdown, text]

Responses​

Schema
    liveURLstringrequired

    URL the viewer opens to watch or interact with the browser.

    liveURLIdstringrequired

    Identifier used to check or close this live URL.

    timeoutnumberrequired

    Applied link lifetime in milliseconds.

    browserExpiresAtnumber | nullnullablerequired

    Enforced session deadline in epoch milliseconds, or null if unbounded.

    targetIdstringrequired

    The page this live URL streams.

Was this page helpful?