Get app

Get installed app info by package name

GET /boxes/{boxId}/android/apps/{packageName}

JavaScript

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() {
  // Create an Android box
  const box = await gboxSDK.create({ type: "android" });

  // Get Android app details by package name
  const androidAppInfo = await box.app.getInfo("com.android.chrome"); // package name
  console.log(`Android App: ${JSON.stringify(androidAppInfo, null, 2)}`);

  // Get app operator for interaction capabilities
  const androidApp = await box.app.get("com.android.chrome");

  // Open the app
  await androidApp.open();
}

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 an Android box
    box = gbox_sdk.create(type="android")

    # Get Android app details by package name
    android_app_info = box.app.get_info("com.android.chrome")  # package name
    print(f"Android App: {android_app_info}")

    # Get app operator for interaction capabilities
    android_app = box.app.get("com.android.chrome")  # package name

    # Open the app
    android_app.open()

if __name__ == "__main__":
    main()

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

200

{
  "packageName": "com.android.settings",
  "activityName": "Settings",
  "activityClassName": "com.android.settings.Settings"
}

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"

packageName · string · required

Android app package name

Example:

"com.example.myapp"

Response

200 - application/json

Android app

Android app

packageName · string · required

App package name

Example:

"com.android.settings"

activityName · string · required

Activity name

Example:

"Settings"

activityClassName · string · required

Activity class name

Example:

"com.android.settings.Settings"