Sign in

v97

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-31135175384.2 KB
Browsers

Create a browser session

Create a new browser session from within an action.

post/browsers

Request body

invocation_idstring

action invocation ID

namestring

Optional human-readable name for the browser session, used to find it later in the dashboard. Must be unique among active sessions within the project. Can be changed later via PATCH /browsers/{id_or_name}.

tagsTags

User-defined key-value tags.

stealthboolean

If true, launches the browser in stealth mode to reduce detection by anti-bot mechanisms.

headlessboolean

If true, launches the browser using a headless image (no VNC/GUI). Defaults to false.

gpuboolean

If true, enables GPU acceleration for the browser session. Requires Start-Up or Enterprise plan and headless=false.

timeout_secondsinteger

The number of seconds of inactivity before the browser session is terminated. Activity includes CDP connections and live view connections. Defaults to 60 seconds. Minimum allowed is 10 seconds. Maximum allowed is 259200 (72 hours). We check for inactivity every 5 seconds, so the actual timeout behavior you will see is +/- 5 seconds around the specified value.

proxy_idstring

Optional proxy to associate to the browser session. Must reference a proxy in the same project as the browser session.

kiosk_modeboolean

If true, launches the browser in kiosk mode to hide address bar and tabs in live view.

start_urlstring

Optional URL to open when the browser session is created. Navigation is best-effort, so navigation failures do not prevent the session from being created.

chrome_policyobject

Custom Chrome enterprise policy overrides applied to this browser session. Keys are Chrome enterprise policy names; values must match their expected types. Blocked: kernel-managed policies (extensions, proxy, CDP/automation). See https://chromeenterprise.google/policies/

Example request

{
  "invocation_id": "rr33xuugxj9h0bkf1rdt2bet",
  "name": "checkout-flow-1",
  "tags": {
    "team": "backend",
    "env": "staging"
  },
  "stealth": true,
  "viewport": {
    "width": 1280,
    "height": 800,
    "refresh_rate": 60
  },
  "kiosk_mode": true,
  "start_url": "https://example.com"
}

Response

Successful response

created_atstring date-time required

When the browser session was created.

cdp_ws_urlstring required

Websocket URL for Chrome DevTools Protocol connections to the browser session

webdriver_ws_urlstring required

Websocket URL for WebDriver BiDi connections to the browser session

browser_live_view_urlstring

Remote URL for live viewing the browser session. Only available for non-headless browsers.

base_urlstring

Metro-API HTTP base URL for this browser session.

headlessboolean required

Whether the browser session is running in headless mode.

stealthboolean required

Whether the browser session is running in stealth mode.

gpuboolean

Whether GPU acceleration is enabled for the browser session (only supported for headful sessions).

session_idstring required

Unique identifier for the browser session

namestring

Human-readable name of the browser session, if one was set at creation.

timeout_secondsinteger required

The number of seconds of inactivity before the browser session is terminated.

proxy_idstring

ID of the proxy associated with this browser session, if any.

kiosk_modeboolean

Whether the browser session is running in kiosk mode.

start_urlstring

URL the session was asked to navigate to on creation, if any. Recorded for debugging. Navigation is fire-and-forget — the URL is dispatched to the browser without waiting for it to load, and any errors (DNS failure, bad status, timeout) are silently dropped. Captures what was requested, not what the browser actually loaded.

chrome_policyobject

Custom Chrome enterprise policy overrides that were applied to this browser session, if any. Echoed back for verification. Keys are Chrome enterprise policy names.

tagsTags

User-defined key-value tags.

deleted_atstring date-time

When the browser session was soft-deleted. Only present for deleted sessions.

Example response

{
  "cdp_ws_url": "wss://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/cdp?jwt=eyJ0eXAi...",
  "webdriver_ws_url": "wss://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/webdriver/session?jwt=eyJ0eXAi...",
  "browser_live_view_url": "https://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/live?jwt=eyJ0eXAi...",
  "base_url": "https://proxy.yul-upbeat-herschel.onkernel.com:8443/browser/kernel",
  "session_id": "htzv5orfit78e1m2biiifpbv",
  "name": "checkout-flow-1",
  "viewport": {
    "width": 1280,
    "height": 800,
    "refresh_rate": 60
  },
  "start_url": "https://example.com",
  "tags": {
    "team": "backend",
    "env": "staging"
  }
}