1. Dispatch API
  2. Starting a Chromium Session

Parameters

start_urlDefault: about:blank
string

The initial URL that is set in the browser. If unset, and a profile is loaded, tabs from the profile are restored

kiosk
boolean

Flag to enable kiosk mode, which hides the browser navigation UI

offline_timeoutDefault: 3600
nullable, number

The seconds after which the session will close when no users are connected. If set to null, the session will never time out. Must be greater than 60

control_disable_default
boolean

If true, users cannot control the browser by default, and need to be manually granted access by an admin user

regionDefault: NA
string

The server region: NA → North America, EU → Europe, AS → Asia

profile.load
string

ID of the session you want to load in the cloud browser (a profile is encrypted browser state from a previous session, with the profile ID being its session_id, see response body). If start_url is unset, tabs from the profile are restored

profile.save
string

profile.save = true → Save profile

ublock
boolean

Flag to install the UBlock Origin extension on the cloud browser

extension.field
string

Field of the multipart form that contains the path to your custom Chrome extension. See “Install custom Chrome extension” below (Max Size 1MB)

webgl
boolean

Enables WebGL. Some games and interactive activities require WebGL

widthDefault: 1280
number

Width of the browser in pixels. If set, height must be set as well. Width must be:

Divisible by 4 Greater than or equal 540

The max number of pixels (width height) is capped at 1920 1080

heightDefault: 720
number

Height of the browser in pixels. If set, width must be set as well. Height must be:

Divisible by 4 Greater than or equal 540

The max number of pixels (width height) is capped at 1920 1080

fpsDefault: 24
number

Integer frame rate of the browser. Must be in the range [24, 60]

hide_cursor
boolean

Hides the system cursor. Useful if you want to implement a multi-cursor user interface.

Response

session_id
string

The ID of the cloud computer session

embed_url
string

A URL you can load into the web client on your website

admin_token
string

A token that grants access to an exclusive subset of the client-side web SDK. Needed for setting permissions and programmatic navigation