Create a session
Creates a new session with the provided configuration.
Request body
Block ads in the browser session. Default is false.
PEM-encoded root CA certificates to trust in this session. THIS IS CURRENTLY AN EXPERIMENTAL FEATURE.
Number of sessions to create concurrently (check your plan limit)
Enable experimental features for the session.
Array of extension IDs to install in the session. Use ['all_ext'] to install all uploaded extensions.
Launch the browser in fullscreen mode, covering the full screen with no Chrome UI. Default is false.
Enable headless browser mode (disable Headful mode)
Inactivity timeout in milliseconds. When set, the session is released if no CDP command or remote input is received for this duration, even if timeout has not yet elapsed. Note that timeout remains the hard cap on session lifetime: if inactivityTimeout is greater than or equal to the effective timeout, it has no effect since timeout always elapses first. Omit to disable.
Enable Selenium mode for the browser session (default is false). Use this when you plan to connect to the browser session via Selenium.
The namespace the session should be created against. Defaults to "default".
This flag will persist the user profile for the session.
This flag will set the profile for the session.
The project to create the session in. When provided, the session namespace is resolved from the project.
Custom proxy URL for the browser session. Overrides useProxy, disabling Steel-provided proxies in favor of your specified proxy. Format: http(s)://username:password@hostname:port
Optional custom UUID for the session
Enable automatic captcha solving. Default is false.
Session timeout duration in milliseconds. Default is 300000 (5 minutes).
Custom user agent string for the browser session
Response
Represents the data structure for a browser session, including its configuration and status.
Timestamp when the session started
Amount of credits consumed by the session
URL for debugging the session
Duration of the session in milliseconds
Number of events processed in the session
Launch the browser in fullscreen mode, covering the full screen with no Chrome UI.
Indicates if the session is headless or headful
Unique identifier for the session
Inactivity timeout in milliseconds, if one was set when the session was created
Indicates if Selenium is used in the session
This flag will persist the profile for the session.
The ID of the profile associated with the session
The project associated with the session
Amount of data transmitted through the proxy
Source of the proxy used for the session
The region where the session was created.
Why the session reached a terminal state. Null while the session is live, or when the reason is unknown (e.g. sessions created before this was tracked). One of: user_requested (released via the API/SDK), timeout (hard timeout elapsed), inactivity_timeout (no activity for the configured window), creation_timeout (never started in time), startup_failed (could not be dispatched), browser_closed (the browser or agent closed itself — not a crash), browser_crashed (the browser crashed or its machine became unresponsive).
URL to view session details
Indicates if captcha solving is enabled
Status of the session
Session timeout duration in milliseconds
User agent string used in the session
URL for the session's WebSocket connection