GET
/
boxes
/
{boxId}
/
display
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" });

  // Get box display state (resolution and orientation)
  const display = await box.display();

  console.log("Resolution:", display.resolution);
  console.log("Orientation:", display.orientation);
}

main();
{
  "resolution": {
    "width": 1920,
    "height": 1080
  },
  "orientation": "portrait"
}

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"

Response

200 - application/json

Box display properties

Box display