Sign in
Sessions

Create a session

Creates a new session with the provided configuration.

post/v1/sessions

Request body

sessionIdstring uuid

Optional custom UUID for the session

userAgentstring

Custom user agent string for the browser session

proxyUrlstring uri

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

blockAdsboolean

Block ads in the browser session. Default is false.

solveCaptchaboolean

Enable automatic captcha solving. Default is false.

timeoutinteger

Session timeout duration in milliseconds. Default is 300000 (5 minutes).

concurrencyinteger

Number of sessions to create concurrently (check your plan limit)

isSeleniumboolean

Enable Selenium mode for the browser session (default is false). Use this when you plan to connect to the browser session via Selenium.

namespacestring

The namespace the session should be created against. Defaults to "default".

{"stackTrail":"components:schemas:CreateSessionRequest:properties:region","oasType":"schema","type":"unknown","description":"The desired region for the session. Available: us-east, us-west, us-central, eu-west, eu-central, ap-northeast, ap-southeast, sa-east. Legacy codes (iad, lax, ord) are also accepted."}
extensionIdsstring[]

Array of extension IDs to install in the session. Use ['all_ext'] to install all uploaded extensions.

persistProfileboolean

This flag will persist the user profile for the session.

profileIdstring uuid

This flag will set the profile for the session.

headlessboolean

Enable headless browser mode (disable Headful mode)

fullscreenboolean

Launch the browser in fullscreen mode, covering the full screen with no Chrome UI. Default is false.

experimentalFeaturesstring[]

Enable experimental features for the session.

Response

Default Response

idstring uuid required

Unique identifier for the session

createdAtstring date-time required

Timestamp when the session started

status'live' | 'released' | 'failed' required

Status of the session

durationinteger required

Duration of the session in milliseconds

eventCountinteger required

Number of events processed in the session

timeoutinteger required

Session timeout duration in milliseconds

creditsUsedinteger required

Amount of credits consumed by the session

websocketUrlstring required

URL for the session's WebSocket connection

debugUrlstring required

URL for debugging the session

sessionViewerUrlstring required

URL to view session details

userAgentstring

User agent string used in the session

proxySource'steel' | 'external' nullable required

Source of the proxy used for the session

proxyBytesUsedinteger required

Amount of data transmitted through the proxy

solveCaptchaboolean

Indicates if captcha solving is enabled

isSeleniumboolean

Indicates if Selenium is used in the session

region'lax' | 'ord' | 'iad' | 'scl' | 'fra' | 'nrt' | 'us-east' | 'us-west' | 'us-central' | 'eu-west' | 'eu-central' | 'ap-northeast' | 'ap-southeast' | 'sa-east'

The region where the session was created. Fly sessions return airport codes; multi-provider sessions return meta-regions.

profileIdstring uuid

The ID of the profile associated with the session

persistProfileboolean

This flag will persist the profile for the session.

headlessboolean

Indicates if the session is headless or headful

fullscreenboolean

Launch the browser in fullscreen mode, covering the full screen with no Chrome UI.

Changes