Starting a Chromium Session

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

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

Timeouts determine when a session will be automatically terminated. Also, when a timeout (or timeout warning) is triggered, a webhook event will be sent to the URL specified by the webhook timeout parameter.

Custom ID provided for keeping track of usage on a per-tenant basis. See Get Usage for more information.

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

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

Used to save and load Chrome profiles including bookmarks, history, passwords, cookies etc. true will create a new profile, while passing in a session ID of an existing profile will load and update the profile. For advanced usage, you can provide an object that specifies the session IDs of the profile you wish to load and the profile you wish to overwrite:

Flag to install the an adblock extension on the cloud browser

Flag to install the a drawing and annotation extension on the cloud browser

Used to install custom Chrome extensions. (Max Size 1MB).

Enables WebGL. Some games and interactive activities require WebGL

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

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

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

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

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

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

Sets the default search engine that Chromium uses: “duckduckgo” | “ecosia” | “google” | “startpage” | “brave”

Sets the user agent to a preset value. Currently only "chrome_android" is supported.

Enables dark mode

The tag property enforces uniqueness. If a session with tag "A" is already running and you attempt to make another session with tag "A", the endpoint will not create a new instance and will instead return the session_id and embed_url of the existing session.

Used to toggle between sharp, smooth, and blocky quality modes. Sharp mode is ideal for situations where reading small text is important. Smooth mode is ideal for anything involving movement (e.g. videos, dynamic activities). Blocky mode is ideal for clients with poor internet connectivity.

Set the browser’s locale and country.

The ID of the cloud computer session

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

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