Browser Sessions

Get a session

Get details about a specific browser session, including the browser address for cdp connection.

get/v1/browser_sessions/{browser_session_id}

Path parameters

browser_session_idstring required

The ID of the browser session. browser_session_id starts with pbs_

Example:pbs_123456

The ID of the browser session. browser_session_id starts with pbs_

Headers

x-api-keystring nullable

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Response

Successfully retrieved browser session details

browser_session_idstring required

Unique identifier for the browser session. browser_session_id starts with pbs_.

organization_idstring required

ID of the organization that owns this session

statusstring nullable

Current status of the browser session

runnable_typestring nullable

Type of the current runnable associated with this session (workflow, task etc)

runnable_idstring nullable

ID of the current runnable

timeoutinteger nullable

Timeout in minutes for the session. Timeout is applied after the session is started. Defaults to 60 minutes.

browser_addressstring nullable

Url for connecting to the browser

app_urlstring nullable

Url for the browser session page

extensionsExtensions[] nullable

A list of extensions installed in the browser session.

browser_type'msedge' | 'chrome' | 'stealth-chromium'

browser_profile_idstring nullable

ID of the browser profile loaded into this session, if any. browser_profile_id starts with bp_.

generate_browser_profileboolean

Whether this session's browser profile will be saved when it ends so it can become a reusable browser profile.

vnc_streaming_supportedboolean

Whether the browser session supports VNC streaming

stream_transportstring nullable

Live-view transport for this session: "vnc" or "cdp". Resolved on the single-session fetch only; null elsewhere.

download_pathstring nullable

The path where the browser session downloads files

started_atstring date-time nullable

Timestamp when the session was started

completed_atstring date-time nullable

Timestamp when the session was completed

created_atstring date-time required

Timestamp when the session was created (the timestamp for the initial request)

modified_atstring date-time required

Timestamp when the session was last modified

deleted_atstring date-time nullable

Timestamp when the session was deleted, if applicable

warningstring nullable

Advisory message about how the request was adjusted, if it was. Set when a requested timeout above the maximum was capped; null otherwise.

Example response

{
  "browser_session_id": "pbs_123456",
  "status": "created",
  "runnable_type": "task",
  "runnable_id": "tsk_123456",
  "timeout": 60,
  "browser_address": "http://localhost:9222",
  "app_url": "https://app.skyvern.com/browser-session/pbs_123456",
  "stream_transport": "vnc"
}

Changes

Changed in 6 of the 86 revisions of this API.1413

Aug 20, 2026701729837d271See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Aug 7, 20269585bc129aaf1See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Aug 2, 202680c55952854d1See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
Jun 12, 20267ce5e3e9a5601See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jun 8, 20263a3616091b66148See the full diff
- ▲
  response property app_url list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property browser_address list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property completed_at list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property deleted_at list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property download_path list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property downloaded_files list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property extensions list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property recordings list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property runnable_id list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property runnable_type list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property started_at list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property status list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property timeout list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  the response's property type changed from string to no type for status
  response-property-type-changed
- ○
  header request parameter x-api-key list-of-types was widened by adding types null
  request-parameter-list-of-types-widened
- ○
  for the header request parameter x-api-key, the type was generalized from string to no type
  request-parameter-type-generalized
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added subschema #2 to the response property anyOf list for the response status
  response-property-any-of-added
- ○
  removed the chrome enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the msedge enum value from the response property for the response status
  response-property-enum-value-removed
This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 4, 2026a8899e7707c41See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history