POST
/
boxes
/
{boxId}
/
actions
/
screen-rotation
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 current display state including orientation
  const currentDisplay = await box.display();
  console.log("Current orientation:", currentDisplay.orientation);

  // Rotate to landscape left (90 degrees)
  await box.action.screenRotation({
    orientation: "landscapeLeft"
  });

  // Check the new orientation
  const newDisplay = await box.display();
  console.log("New orientation:", newDisplay.orientation);

  // Rotate to portrait upside down (180 degrees)
  await box.action.screenRotation({
    orientation: "portraitUpsideDown"
  });
}

main();
{
  "message": "Action executed successfully",
  "screenshot": {
    "trace": {
      "uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA..."
    },
    "before": {
      "uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA..."
    },
    "after": {
      "uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA..."
    }
  }
}

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

Screen rotation parameters

Response

200 - application/json

Result of an UI action execution with optional screenshots