Open app

Launches a specific Android application within the box

POST /boxes/{boxId}/android/packages/{packageName}/open

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

  const androidApp = await box.app.get("com.android.settings"); // package name

  await androidApp.open();

  await androidApp.open({ activityName: "com.android.settings.Settings" });
}

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")

    # Connect to Android app by package name
    android_app = box.app.get("com.android.settings")  # package name

    # Start the app with specific activity
    android_app.open(activity_name="com.android.settings.Settings")

if __name__ == "__main__":
    main()

curl --request POST \
  --url https://gbox.ai/api/v1/boxes/{boxId}/android/packages/{packageName}/open \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "activityName": "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"

Body

application/json

Android pkg start

activityName · string

Activity name, default is the main activity.

Example:

"com.android.settings.Settings"

Response

200 - undefined