Create a browser session
Create a new browser session from within an action.
Authorizations
Body
Parameters for creating a browser session.
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/
Closed beta: contact Kernel to enable fingerprint overrides for your organization. Overrides browser attributes presented to websites for this session. Supports linux and macos and requires captcha_solver.enabled=true, headless=false, gpu=false, and default memory. Omit to preserve the default browser behavior.
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}.
1 - 255^[a-zA-Z0-9._-]{1,255}$"checkout-flow-1"
Proxy configuration for the browser session. Cannot be combined with proxy_id. Omit to use direct egress, or Kernel's default stealth proxy when stealth=true. Set mode to direct to force direct egress. Set mode to default to use Kernel's default stealth proxy when captcha_solver.enabled=true, or direct egress otherwise. Select id or name to use that proxy. Proxy selection does not change CAPTCHA solver behavior.
- Option 1
- Option 2
- Option 3
If true, enables the CAPTCHA solver and, when proxy is omitted, uses Kernel's default stealth proxy. Defaults to false. Equivalent to captcha_solver.enabled=true with proxy.mode=default. Cannot be combined with captcha_solver.enabled=false. Deprecated in favor of captcha_solver and proxy.
true
Telemetry configuration for the browser session. Set enabled to true to start capture using VM defaults, or provide browser category settings. If omitted, null, set to an empty object ({}), set to enabled: false without browser category settings, or all four categories are explicitly disabled, capture is not started.
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.
10 <= x <= 259200Video memory (VRAM) for a GPU browser session. Requires gpu=true. Defaults to 3GiB, which comes with 4 vCPU and 6GiB memory. 6GiB comes with 8 vCPU and 12GiB memory. 2GiB and 4GiB are deprecated aliases for 3GiB and 6GiB.
3GiB, 6GiB, 2GiB, 4GiB "3GiB"
Initial browser window size in pixels with optional refresh rate. If omitted, image defaults apply (1920x1080@25). For GPU images, the default is 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted. Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25, 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60, 768x1024@60, 390x844@60. For GPU images, recommended presets use one of these resolutions with refresh rates 60, 30, 25, or 10: 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800, 1280x720, 1368x768, 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250, 768x1024, 800x1600. Viewports outside this list may exhibit unstable live view or recording behavior. If refresh_rate is not provided, it will be automatically determined based on the resolution (higher resolutions use lower refresh rates to keep bandwidth reasonable).
Response
Successful response
Whether the browser session has CAPTCHA solving enabled, in which case proxy.mode=default uses Kernel's default stealth proxy. A browser created with only captcha_solver reports true with proxy.mode=direct. Deprecated in favor of captcha_solver and proxy.
false
URL the session was most recently asked to navigate to, 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.
"https://example.com"
Initial browser window size in pixels with optional refresh rate. If omitted, image defaults apply (1920x1080@25). For GPU images, the default is 1920x1080@60. Arbitrary viewport dimensions and refresh rates are accepted. Known-good presets include: 2560x1440@10, 1920x1080@25, 1920x1200@25, 1440x900@25, 1280x800@60, 1024x768@60, 1200x800@60, 768x1024@60, 390x844@60. For GPU images, recommended presets use one of these resolutions with refresh rates 60, 30, 25, or 10: 800x600, 960x720, 1024x576, 1024x768, 1152x648, 1200x800, 1280x720, 1368x768, 1440x900, 1600x900, 1920x1080, 1920x1200, 390x844, 360x250, 768x1024, 800x1600. Viewports outside this list may exhibit unstable live view or recording behavior. If refresh_rate is not provided, it will be automatically determined based on the resolution (higher resolutions use lower refresh rates to keep bandwidth reasonable).