POST
/
console
Starting a Console Emulator
curl --request POST \
  --url https://engine.hyperbeam.com/console \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "<string>",
  "room_url": "<string>",
  "auth": {}
}'
{
  "session_id": "52f968cb-6739-4197-83d7-2305fe5d6f54",
  "embed_url": "https://vwdrccwgpv181powg61ggyvy.hyperbeam.com/Uvloy2c5QZeD1yMF_l1vVA?token=c8iw3SmQglOU0ugfLr3dWY2LalSKI_WOGUldEt8knbw",
  "admin_token": "51JOZEEcMp4trCwbpTS3jjQc0lSmeAZpPfxioDqe73U"
}

​
Request Access

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

​
Parameters

​
type
string
default:"''"
required
The console type. nes, snes, n64, and ps1 are supported.
​
room_url
string
default:"''"
required
URL to a legal ROM file, which will be downloaded and loaded into the emulator.
​
auth
object
default:"\"auth\": {\"type\": \"token\"}}"
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