Skip to main content
POST
/
boxes
/
{boxId}
/
web-terminal-url
JavaScript
import GboxSDK from "gbox-sdk";

const gboxSDK = new GboxSDK({
  apiKey: process.env["GBOX_API_KEY"] // This is the default and can be omitted
});

async function main() {
  const box = await gboxSDK.create({ type: "android" });

  const liveViewUrl = await box.liveView();

  console.log(`Live view url: ${liveViewUrl.url}`);
}

main();
{
  "url": "https://live.gbox.cloud/web-terminal/c9bdc193-b54b-4ddb-a035-5ac0c598d32d"
}

Authorizations

​
Authorization
string
header
required

Enter your API Key in the format: Bearer <token>. Get it from https://gbox.ai

Path Parameters

​
boxId
string
required

Box ID

Example:

"c9bdc193-b54b-4ddb-a035-5ac0c598d32d"

Body

application/json

Web terminal configuration

​
expiresIn
string
default:180m

The web terminal will be alive for the given duration

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: "500ms", "30s", "5m", "1h" Default: 180m

Example:

"180m"

Response

201 - application/json

Generate pre-signed web terminal url

Web terminal result

​
url
string
required

Web terminal url

Example:

"https://live.gbox.cloud/web-terminal/c9bdc193-b54b-4ddb-a035-5ac0c598d32d"

⌘I