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 screen layout
  const layout = await box.action.screenLayout();

  console.log(layout);
}

main();

import os
from gbox_sdk import GboxSDK

def main():
    gbox_sdk = GboxSDK(api_key=os.environ["GBOX_API_KEY"])  # This is the default and can be omitted

    # Create Android box
    box = gbox_sdk.create(type="android")

    # Get screen layout
    layout = box.action.screen_layout()

    print(layout)

if __name__ == "__main__":
    main()

curl --request GET \
  --url https://gbox.ai/api/v1/boxes/{boxId}/actions/screen-layout \
  --header 'Authorization: Bearer <token>'

{
  "content": "<?xml version='1.0' encoding='UTF-8' standalone='yes' ?>\n<hierarchy rotation=\"0\">\n  <node index=\"0\" text=\"\" resource-id=\"\" class=\"android.widget.FrameLayout\" package=\"com.android.systemui\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,2316]\" displayed=\"true\">\n    <!-- UI elements -->\n  </node>\n</hierarchy>"
}

UI Action

Get screen layout

Get the current structured screen layout information. This endpoint returns detailed structural information about the UI elements currently displayed on the screen, which can be used for UI automation, element analysis, and accessibility purposes. The format varies by box type: Android boxes return XML format with detailed UI hierarchy information including element bounds, text content, resource IDs, and properties, while other box types may return different structured formats.

GET

boxes

{boxId}

actions

screen-layout

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 screen layout
  const layout = await box.action.screenLayout();

  console.log(layout);
}

main();

import os
from gbox_sdk import GboxSDK

def main():
    gbox_sdk = GboxSDK(api_key=os.environ["GBOX_API_KEY"])  # This is the default and can be omitted

    # Create Android box
    box = gbox_sdk.create(type="android")

    # Get screen layout
    layout = box.action.screen_layout()

    print(layout)

if __name__ == "__main__":
    main()

curl --request GET \
  --url https://gbox.ai/api/v1/boxes/{boxId}/actions/screen-layout \
  --header 'Authorization: Bearer <token>'

{
  "content": "<?xml version='1.0' encoding='UTF-8' standalone='yes' ?>\n<hierarchy rotation=\"0\">\n  <node index=\"0\" text=\"\" resource-id=\"\" class=\"android.widget.FrameLayout\" package=\"com.android.systemui\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,2316]\" displayed=\"true\">\n    <!-- UI elements -->\n  </node>\n</hierarchy>"
}

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

Structured screen layout information (XML format for Android boxes)

Screen layout content.

Android boxes (XML):

Browser (Linux) boxes (HTML):

Example

Hello World

content

string

required

Screen layout content.

Android boxes (XML):

<?xml version='1.0' encoding='UTF-8' standalone='yes'?>
<hierarchy rotation="0">
  <node ... />
</hierarchy>

Browser (Linux) boxes (HTML):

<html>
  <head><title>Example</title></head>
  <body>
    <h1>Hello World</h1>
  </body>
</html>

Example:

"<?xml version='1.0' encoding='UTF-8' standalone='yes' ?>\n<hierarchy rotation=\"0\">\n <node index=\"0\" text=\"\" resource-id=\"\" class=\"android.widget.FrameLayout\" package=\"com.android.systemui\" content-desc=\"\" checkable=\"false\" checked=\"false\" clickable=\"false\" enabled=\"true\" focusable=\"false\" focused=\"false\" scrollable=\"false\" long-clickable=\"false\" password=\"false\" selected=\"false\" bounds=\"[0,0][1080,2316]\" displayed=\"true\">\n \n </node>\n</hierarchy>"

Take screenshot Start recording