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

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

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"
}

Changes

Changed in 5 of the 63 revisions of this API.59

Jun 13, 2026e7044f43e57e1See the full diff
- ○
  added the optional property generate_browser_profile to the response with the 200 status
  response-optional-property-added
May 9, 20269a8565aaedbf4See the full diff
- ○
  added the optional property downloaded_files/anyOf[subschema #1]/items/artifact_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property downloaded_files/anyOf[subschema #1]/items/file_size to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property recordings/anyOf[subschema #1]/items/artifact_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property recordings/anyOf[subschema #1]/items/file_size to the response with the 200 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 9, 2026f97d3f2efafe4See the full diff
- ●
  removed the optional property downloaded_files/anyOf[subschema #1]/items/artifact_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property downloaded_files/anyOf[subschema #1]/items/file_size from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property recordings/anyOf[subschema #1]/items/artifact_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property recordings/anyOf[subschema #1]/items/file_size from the response with the 200 status
  response-optional-property-removed
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 9, 20269a8565aaedbf4See the full diff
- ○
  added the optional property downloaded_files/anyOf[subschema #1]/items/artifact_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property downloaded_files/anyOf[subschema #1]/items/file_size to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property recordings/anyOf[subschema #1]/items/artifact_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property recordings/anyOf[subschema #1]/items/file_size to the response with the 200 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 21, 2026458f1f2bbd451See the full diff
- ●
  added the new stealth-chromium enum value to the browser_type/anyOf[subschema #1: PersistentBrowserType]/ response property for the response status 200
  response-property-enum-value-added

Full history