Skip to main content
GET
/
v1
/
browser_sessions
Get active browser sessions
curl --request GET \
  --url https://api.skyvern.com/v1/browser_sessions
[
  {
    "browser_session_id": "pbs_123456",
    "organization_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "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",
    "extensions": [
      "ad-blocker"
    ],
    "browser_type": "msedge",
    "vnc_streaming_supported": false,
    "download_path": "<string>",
    "downloaded_files": [
      {
        "url": "<string>",
        "checksum": "<string>",
        "filename": "<string>",
        "modified_at": "2023-11-07T05:31:56Z"
      }
    ],
    "recordings": [
      {
        "url": "<string>",
        "checksum": "<string>",
        "filename": "<string>",
        "modified_at": "2023-11-07T05:31:56Z"
      }
    ],
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
]

Headers

​
x-api-key
string | null

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

Response

Successfully retrieved all active browser sessions

​
browser_session_id
string
required

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

Example:

"pbs_123456"

​
organization_id
string
required

ID of the organization that owns this session

​
created_at
string<date-time>
required

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

​
modified_at
string<date-time>
required

Timestamp when the session was last modified

​
status
string | null

Current status of the browser session

Example:

"created"

​
runnable_type
string | null

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

Example:

"task"

​
runnable_id
string | null

ID of the current runnable

Example:

"tsk_123456"

​
timeout
integer | null

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

Example:

60

​
browser_address
string | null

Url for connecting to the browser

Example:

"http://localhost:9222"

​
app_url
string | null

Url for the browser session page

Example:

"https://app.skyvern.com/browser-session/pbs_123456"

​
extensions
enum<string>[] | null

A list of extensions installed in the browser session.

Available options:
ad-blocker,
captcha-solver
​
browser_type
enum<string> | null

The type of browser used for the session.

Available options:
msedge,
chrome
​
vnc_streaming_supported
boolean
default:false

Whether the browser session supports VNC streaming

​
download_path
string | null

The path where the browser session downloads files

​
downloaded_files
FileInfo · object[] | null

The list of files downloaded by the browser session

​
recordings
FileInfo · object[] | null

The list of video recordings from the browser session

​
started_at
string<date-time> | null

Timestamp when the session was started

​
completed_at
string<date-time> | null

Timestamp when the session was completed

​
deleted_at
string<date-time> | null

Timestamp when the session was deleted, if applicable