Sign in
Sessions

Launch a browser session

Changed on

Launch a browser session

post/v1/sessions

Request

  • Base URL: http://0.0.0.0:3000
  • URL: http://0.0.0.0:3000/v1/sessions
  • Auth: none declared

Request body

sessionIdstring uuid

Unique identifier for the session

proxyUrlstring

Proxy URL to use for the session

userAgentstring

User agent string to use for the session

isSeleniumboolean

Indicates if Selenium is used in the session

blockAdsboolean

Flag to indicate if ads should be blocked in the session

skipFingerprintInjectionboolean

Flag to indicate if fingerprint injection should be skipped for this session.

logSinkUrlstring

Deprecated: Log sink URL to use for the session

extensionsstring[]

Extensions to use for the session

persistboolean

Flag to indicate if session should be persisted

userDataDirstring

User data directory path to use for the session

timezonestring

Timezone to use for the session

userPreferencesobject

Chrome user preferences to customize browser behavior (e.g., font size, popup blocking, notification settings)

extraobject

Extra metadata to help initialize the session

headlessboolean

Headless mode for the session

Response

Default Response

idstring uuid required

Unique identifier for the session

createdAtstring date-time required

Timestamp when the session started

status'idle' | '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 a viewing the live browser instance for the session

debuggerUrlstring required

URL for debugging the session

sessionViewerUrlstring required

URL to view session details

userAgentstring

User agent string used in the session

proxystring

Proxy server used for the session

proxyTxBytesinteger required

Amount of data transmitted through the proxy

proxyRxBytesinteger required

Amount of data received through the proxy

solveCaptchaboolean

Indicates if captcha solving is enabled

isSeleniumboolean

Indicates if Selenium is used in the session

Changes

  • e9b353bff1f5Revision changes
    • warning

      added the new idle enum value to the response property for the response status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status