Starting a Session

Chromium
Android emulator
NES emulator
Want to run something else? Let us know at founders@hyperbeam.com

Starting a session

Chromium

POST

/vm

Property	Type	Default	Description
`start_url`	string	“about:blank”	The initial URL that is set in the browser. If unset, and a profile is loaded, tabs from the profile are restored
`kiosk`	boolean	false	Flag to enable kiosk mode, which hides the browser navigation UI
`offline_timeout`	nullable, number	3600	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	false	If true, users cannot control the browser by default, and need to be manually granted access by an admin user
`region`	string	“NA”	The server region: “NA” → North America, “EU” → Europe, “AS” → Asia
`profile.load`	string	unset	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`	boolean	unset	profile.save = true → Save profile
`ublock`	boolean	false	Flag to install the UBlock Origin extension on the cloud browser
`extension.field`	string	unset	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	false	Enables WebGL. Some games and interactive activities require WebGL
`width`	number	1280	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
`height`	number	720	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
`fps`	number	24	Integer frame rate of the browser. Must be in the range [24, 60]
`hide_cursor`	boolean	false	Hides the system cursor. Useful if you want to implement a multi-cursor user interface.

Example response


            
            Copied
          {
  "session_id": "52f968cb-6739-4197-83d7-2305fe5d6f54",
  "embed_url": "https://vwdrccwgpv181powg61ggyvy.hyperbeam.com/Uvloy2c5QZeD1yMF_l1vVA?token=c8iw3SmQglOU0ugfLr3dWY2LalSKI_WOGUldEt8knbw",
  "admin_token": "51JOZEEcMp4trCwbpTS3jjQc0lSmeAZpPfxioDqe73U"
}

Property	Type	Description
`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.

Android Emulator

POST

/android

Property	Type	Default	Description
`app_id`	string	unset	The Google playstore application ID. If app_id is not set, then the home screen will be loaded.

Example response


            
            Copied
          {
  "session_id": "52f968cb-6739-4197-83d7-2305fe5d6f54",
  "embed_url": "https://vwdrccwgpv181powg61ggyvy.hyperbeam.com/Uvloy2c5QZeD1yMF_l1vVA?token=c8iw3SmQglOU0ugfLr3dWY2LalSKI_WOGUldEt8knbw",
  "admin_token": "51JOZEEcMp4trCwbpTS3jjQc0lSmeAZpPfxioDqe73U"
}

Property	Type	Description
`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.

Console Emulator

POST

/console

Property	Type	Default	Description
`type` (required)	string	""	The console type. nes, snes, n64, and ps1 are supported.
`room_url` (required)	string	""	URL to a legal ROM file, which will be downloaded and loaded into the emulator.
`auth`	object	{“auth”: {“type”: “token”}}	The authentication system for the cloud computer. See the “cloud computer authentication” section for more info.

Example response


            
            Copied
          {
  "session_id": "52f968cb-6739-4197-83d7-2305fe5d6f54",
  "embed_url": "https://vwdrccwgpv181powg61ggyvy.hyperbeam.com/Uvloy2c5QZeD1yMF_l1vVA?token=c8iw3SmQglOU0ugfLr3dWY2LalSKI_WOGUldEt8knbw",
  "admin_token": "51JOZEEcMp4trCwbpTS3jjQc0lSmeAZpPfxioDqe73U"
}

Property	Type	Description
`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 API. Needed for setting permissions and programmatic navigation.

​Starting a session

​Chromium

​Android Emulator

​Console Emulator

Starting a session

Chromium

Android Emulator

Console Emulator