Skip to main content
POST
Create Session

Overview

Creates a new browser session backed by a sandboxed VM. The session stays alive until it hits timeout of inactivity, you destroy it explicitly, or it expires at expiresAt. Returns a cdpUrl you can attach to with any Chrome DevTools Protocol client (Playwright, Puppeteer, chromedp), plus a liveViewUrl for an interactive noVNC view.

Body

string[]
Runtime capabilities to enable on the session. Supported values include stealth (anti-bot evasion) and recording (server-side MP4 capture).
string[]
Extension IDs to load into the browser. Upload extensions first via POST /browser/extensions.
string
Raw proxy URL (e.g. http://user:pass@host:port). Mutually exclusive with proxy.
object
Managed proxy options. Mutually exclusive with proxyUrl.
integer
default:"900000"
Idle timeout in ms before the session auto-terminates. Default 15 minutes.

Example Request

Response

Success Response (201)

string
Session ID (UUID). Use this as {id} in all other browser session endpoints.
string
Current state — typically ready when the session is immediately usable.
string
Chrome DevTools Protocol WebSocket URL. Attach any CDP client here.
string
Shareable noVNC URL for interactive live view.
string[]
Capabilities enabled on this session.
string[]
Extension IDs loaded into the browser.
string
Raw proxy URL, when the session was created with proxyUrl.
object
Managed proxy info — enabled, provider, location, sticky.
integer
Unix epoch milliseconds when the session was created.
integer
Unix epoch milliseconds when the session will auto-expire absent activity.
Example Response:

Error Responses