SKskyvern-ai
Browser Sessions

Get a session

Changed on

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

get/v1/browser_sessions/{browser_session_id}

Request

  • Base URL
    https://api.skyvern.com
  • URL
    https://api.skyvern.com/v1/browser_sessions/{browser_session_id}
  • Auth
    API key in header x-api-key

Path parameters

browser_session_idstring required

The ID of the browser session. browser_session_id starts with pbs_

Example:pbs_123456

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_bystring nullable

ID of the user who created the session

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 at creation, when an extension was granted less than it asked for, or when an extension was accepted but not yet confirmed; null otherwise.

source'managed' | 'external'

"external" for a browser the caller registered and runs itself; "managed" for one Skyvern runs.

remaining_lifetime_secondsinteger nullable

Seconds left before a registered external browser's fixed deadline. Null for managed sessions and once the session has ended.

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",
  "browser_settings": {
    "timezone_id": "America/New_York"
  },
  "stream_transport": "vnc"
}

Changes

  • 539f04093540Revision changes
    • warning

      deleted the header request parameter x-api-key

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

  • c6e525ba952dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status