Skip to main content
POST
Attach to a browser session

Authorizations

Authorization
string
header
required

JWT authentication token

Path Parameters

session_ref
string
required

Opaque browser session reference (brs_)

Query Parameters

project_id
string<uuid>

Optional project ID for project sandbox scope (requires membership)

Body

application/json
operation
enum<string>
default:view

Access scope: 'view' (read-only live view) or 'control' (view + input).

Available options:
view,
control

Response

Stream authorization with a short-lived token

expiresAt
string<date-time>
required

Token expiry (RFC3339).

mode
string
required

'cloud' or 'local'.

sessionRef
string
required

Opaque browser session reference (brs_).

status
string
required

Lifecycle status: 'active', 'closed', or 'error'.

streamUrl
string
required

Neo-authorized stream URL (relative) carrying the short-lived token.

Example:

"/api/v1/browser/sessions/brs_abc/stream?token=..."

token
string
required

Short-lived scoped Neo stream token.

engine
string

'chrome' or 'lightpanda'.

liveViewUrl
string

Direct provider live view URL (cloud sessions only). Embeddable page with no API keys; preferred over streamUrl when present since it skips the sandbox stream hop.

profileId
string

Reusable profile reference, if any.