Skip to main content
PATCH
Rename 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
label
string
required

New user-assigned display name, persisted in the manifest.

Example:

"Claimflow admin"

Response

The rewritten browser session manifest with the new label

mode
string
required

'cloud' (Kernel/Browserbase) or 'local' (sandbox).

Example:

"cloud"

sessionRef
string
required

Opaque Neo-issued reference (brs_) exposed to UI/agents.

Example:

"brs_0f1e2d3c4b5a69788796a5b4"

status
string
required

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

Example:

"active"

threadId
string
required

Task thread this session belongs to.

artifactsDir
string

Sandbox directory for session artifacts (e.g. screenshots).

capturedTabs
object[]

Open tabs captured from the live session, used to restore the working set when a cloud session resumes to about:blank. Sandbox-resident only.

createdAt
string

ISO timestamp when the session was first created.

createdBy
string

'agent' or 'ui'.

engine
string

'chrome' or 'lightpanda' (local only).

Example:

"chrome"

label
string

User-assigned display name for UI-created sessions.

Example:

"MetaMask login"

lastAttachedAt
string

ISO timestamp the session was last attached/resumed.

lastCapturedAt
string

ISO timestamp the tab set was last captured.

manifestPath
string

Sandbox-relative manifest path (audit/debug; no secrets).

profileId
string

Reusable profile reference; absent for ephemeral/isolated sessions.

provider
object
recordingsEnabled
boolean
schemaVersion
integer

Manifest schema version.

startUrl
string

Full initial URL a UI session was created with (UI sessions only).

Example:

"https://app.uniswap.org"

target
object
updatedAt
string

ISO timestamp when the manifest was last written.

userId
string

Owning user id.