Skip to main content
GET
/
boxes
/
{boxId}
/
actions
/
settings
JavaScript
import GboxSDK from "gbox-sdk";

const gboxSDK = new GboxSDK({
  apiKey: process.env["GBOX_API_KEY"]
});

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

  // Get UI Action setting
  const setting = await box.action.getSettings();
  console.log("Current setting:", setting);
}

main();
{
  "scale": 1
}

Documentation Index

Fetch the complete documentation index at: https://docs.gbox.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
boxId
string
required

Box ID

Example:

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

Response

200 - application/json

Action setting

​
scale
number
default:1
required

The scale of the action to be performed. Must be greater than 0.1 and less than or equal to 1.

Notes:

  • Scale does not change the box's actual screen resolution.
  • It affects the size of the output screenshot and the coordinates/distances of actions. Coordinates and distances are scaled by this factor. Example: when scale = 1, Click({x:100, y:100}); when scale = 0.5, the equivalent position is Click({x:50, y:50}).
Required range: 0.1 <= x <= 1
Example:

1