Hyperbeam home pagelogo
Dispatch API
Starting a Console Emulator
POST

/console

Bearer*
curl --request POST \
  --url https://engine.hyperbeam.com/console \
  --header 'Bearer: <bearer>' \
  --data '{
  "type": "<type>",
  "room_url": "<room_url>"
}'

​
Request Access

This feature is currently in private beta. Request access here.

​
Parameters

typerequiredDefault: "''"
string

The console type. nes, snes, n64, and ps1 are supported.

room_urlrequiredDefault: "''"
string

URL to a legal ROM file, which will be downloaded and loaded into the emulator.

authDefault: "\"auth\": {\"type\": \"token\"}}"
object

The authentication system for the cloud computer. See the “cloud computer authentication” section for more info.

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

​
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 JavaScript SDK. Needed for setting permissions and programmatic navigation