Browser Sessions

List browser sessions, optionally filtered

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringOptional

Filter by repository identifier (e.g., owner/repo)

prNumbernumberOptional

Filter by pull request number

environmentIdstringOptional

Filter by environment id

statusstring · enumOptional

Filter by session status

Possible values:

Responses

200

List of browser sessions

No content

403

Forbidden - Requires role: owner, member, application

get/sfp/api/browser-sessions

HTTPcURLJavaScriptPython

GET /sfp/api/browser-sessions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Start a recorded browser session for a PR's assigned review environment

post

Resolves the active review-environment assignment for the PR, then dispatches the record flow. Works for pool review-environment sandboxes (which are not named environments). Use POST /environments/:id/browser/record to record against a named environment instead.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

repositoryIdentifierstringRequired

Repository identifier (owner/repo, or org/project/repo for ADO)

prNumbernumberRequired

Pull request number that has an active review-environment assignment

domainstringOptional

Review-environment domain (for multi-domain assignments)

modestringOptional

Session mode

Default: record

retUrlstringOptional

Return URL to open in the recorded Salesforce session

Responses

201

Browser session provisioning

No content

400

No active review environment assigned to the PR

403

Forbidden - Requires role: owner, member, application

post/sfp/api/browser-sessions/record-for-pr

HTTPcURLJavaScriptPython

POST /sfp/api/browser-sessions/record-for-pr HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "repositoryIdentifier": "text",
  "prNumber": 1,
  "domain": "text",
  "mode": "record",
  "retUrl": "text"
}

No content

Get a browser session by id

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Browser session id

Responses

200

Browser session details

No content

403

Forbidden - Requires role: owner, member, application

404

Browser session not found

get/sfp/api/browser-sessions/{id}

HTTPcURLJavaScriptPython

GET /sfp/api/browser-sessions/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete a browser session

delete

Stops the remote Browserbase session if it is still running, then removes the session record.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Browser session id

Responses

200

Session deleted

No content

403

Forbidden - Requires role: owner, member, application

404

Browser session not found

delete/sfp/api/browser-sessions/{id}

HTTPcURLJavaScriptPython

DELETE /sfp/api/browser-sessions/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a browser session (internal worker write-back)

patch

Application-token only. Used by the Hatchet worker to write session faces (provider session id, live view URL, status) back to the server. Not a user-facing endpoint.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Browser session id

Body

application/json

providerSessionIdstringOptional

Provider (Browserbase) session id

projectIdstringOptional

Provider project id

liveViewUrlstringOptional

Live view URL for the running session

instanceUrlstringOptional

Salesforce instance URL

salesforceUsernamestringOptional

Salesforce username

statusstring · enumOptional

Session status

Possible values:

errorstringOptional

Error message if the session failed

startedAtstringOptional

Session start time (ISO 8601)

expiresAtstringOptional

Session expiry time (ISO 8601)

Responses

200

Updated browser session

No content

403

Forbidden - Requires role: application

404

Browser session not found

patch/sfp/api/browser-sessions/{id}

HTTPcURLJavaScriptPython

PATCH /sfp/api/browser-sessions/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 194

{
  "providerSessionId": "text",
  "projectId": "text",
  "liveViewUrl": "text",
  "instanceUrl": "text",
  "salesforceUsername": "text",
  "status": "provisioning",
  "error": "text",
  "startedAt": "text",
  "expiresAt": "text"
}

No content

List replay pages for a recorded session

get

Proxies the Browserbase replays listing for the session. Resolved by session id — no environment id required, so it works for pool review environments and the in-app inspect view.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Browser session id

Responses

200

Replay pages

No content

403

Forbidden - Requires role: owner, member, application

425

Replay not available yet (session still running)

get/sfp/api/browser-sessions/{id}/replays

HTTPcURLJavaScriptPython

GET /sfp/api/browser-sessions/{id}/replays HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get a replay page playlist (m3u8) for a recorded session

get

Proxies the Browserbase replay page and returns its HLS playlist with segment URLs rewritten to the same-origin segment proxy.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Browser session id

pageIdstringRequired

Replay page id

Responses

200

HLS playlist (application/vnd.apple.mpegurl)

No content

403

Forbidden - Requires role: owner, member, application

get/sfp/api/browser-sessions/{id}/replays/{pageId}

HTTPcURLJavaScriptPython

GET /sfp/api/browser-sessions/{id}/replays/{pageId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Stream a recorded replay segment

get

Fetches a single HLS segment (or init segment) from the Browserbase CDN server-side and streams it, so the recording stays behind the server auth instead of exposing tokened CDN URLs.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Browser session id

pageIdanyRequired

Replay page id

Query parameters

ustringRequired

Opaque (base64url) reference to the CDN segment, as emitted in the proxied playlist

Responses

200

Binary media segment

No content

403

Forbidden - Requires role: owner, member, application

get/sfp/api/browser-sessions/{id}/replays/{pageId}/segment

HTTPcURLJavaScriptPython

GET /sfp/api/browser-sessions/{id}/replays/{pageId}/segment?u=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Extend a browser session

post

Bumps expires_at by the requested minutes, capped so total lifetime never exceeds 60 minutes.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Browser session id

Body

application/json

minutesnumberOptional

Minutes to extend the session by

Default: 15

Responses

200

Extended browser session

No content

403

Forbidden - Requires role: owner, member, application

404

Browser session not found

post/sfp/api/browser-sessions/{id}/extend

HTTPcURLJavaScriptPython

POST /sfp/api/browser-sessions/{id}/extend HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "minutes": 15
}

No content

Stop a running browser session

post

Ends the remote Browserbase session and marks the session ended, keeping the record so its recording can be replayed. Use DELETE to discard the record instead.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Browser session id

Responses

200

Session stopped (ended)

No content

403

Forbidden - Requires role: owner, member, application

404

Browser session not found

post/sfp/api/browser-sessions/{id}/stop

HTTPcURLJavaScriptPython

POST /sfp/api/browser-sessions/{id}/stop HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Start a recorded Browserbase session for an environment

post

Provisions a browser session and dispatches the record-browser-session flow to Hatchet. Owner/application only — a recorded session auto-authenticates into the org, matching the owner-gated frontdoor for named environments.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

envIdstringRequired

Environment id

Body

application/json

modestringOptional

Session mode

Default: recordExample: record

retUrlstringOptional

Return URL to open in the recorded Salesforce session

prNumbernumberOptional

Pull request number this session is bound to

Responses

201

Browser session provisioning

No content

403

Forbidden - Requires role: owner, application

404

Environment not found

409

Browserbase integration not configured

post/sfp/api/environments/{envId}/browser/record

HTTPcURLJavaScriptPython

POST /sfp/api/environments/{envId}/browser/record HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "mode": "record",
  "retUrl": "text",
  "prNumber": 1
}

No content

List replay pages for a recorded session

get

Proxies the Browserbase replays listing for the session.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

sessionIdstringRequired

Browser session id

envIdanyRequired

Environment id

Responses

200

Replay pages

No content

403

Forbidden - Requires role: owner, member, application

get/sfp/api/environments/{envId}/browser/replay/{sessionId}

HTTPcURLJavaScriptPython

GET /sfp/api/environments/{envId}/browser/replay/{sessionId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get a replay page playlist (m3u8) for a recorded session

get

Proxies the Browserbase replay page and returns its HLS playlist.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

sessionIdstringRequired

Browser session id

pageIdstringRequired

Replay page id

envIdanyRequired

Environment id

Responses

200

HLS playlist (application/vnd.apple.mpegurl)

No content

403

Forbidden - Requires role: owner, member, application

get/sfp/api/environments/{envId}/browser/replay/{sessionId}/{pageId}

HTTPcURLJavaScriptPython

GET /sfp/api/environments/{envId}/browser/replay/{sessionId}/{pageId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content