Starting a Console Emulator

Initiate a Console Emulator using Hyperbeam

POST /console

Starting a Console Emulator

cURL

curl --request POST \
  --url https://engine.hyperbeam.com/console \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "<string>",
  "room_url": "<string>",
  "auth": {}
}
'

import requests

url = "https://engine.hyperbeam.com/console"

payload = {
    "type": "<string>",
    "room_url": "<string>",
    "auth": {}
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({type: '<string>', room_url: '<string>', auth: {}})
};

fetch('https://engine.hyperbeam.com/console', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://engine.hyperbeam.com/console",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => '<string>',
    'room_url' => '<string>',
    'auth' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://engine.hyperbeam.com/console"

	payload := strings.NewReader("{\n  \"type\": \"<string>\",\n  \"room_url\": \"<string>\",\n  \"auth\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://engine.hyperbeam.com/console")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"<string>\",\n  \"room_url\": \"<string>\",\n  \"auth\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://engine.hyperbeam.com/console")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"<string>\",\n  \"room_url\": \"<string>\",\n  \"auth\": {}\n}"

response = http.request(request)
puts response.read_body

Response Example

{
  "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.

Response Example

{
  "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