Basic

GBOX provides cloud-based Android automation testing without the need to purchase, configure, or maintain any Android devices. GBOX supports both virtual machines and physical devices, letting you focus on testing:

• No Device Management - Eliminate hardware procurement, system configuration, and device maintenance hassles
• Ready to Use - Get clean Android testing environments in seconds
• Flexible Options - Choose between virtual machines or physical devices based on your testing needs
• Auto Scaling - Run multiple tests in parallel without hardware limitations

1. Get an API Key

   1. Go to GBOX AI
   2. Copy your API Key
   3. Paste your GBOX API Key into your env file

   .env

   GBOX_API_KEY=gbox-******
   
2. Install GBOX SDK and other dependencies

   Install gbox-sdk and other dependencies by running the following command in your terminal.

   Typescript

   npm install gbox-sdk dotenv typescript tsx @types/node
   

   # Set up a virtual environment
   python3 -m venv venv
   source venv/bin/activate
   
   pip install gbox-sdk python-dotenv
   
3. Create a basic Android box

   Create a basic Android box by running the following code.

   Typescript

   import GboxSDK from "gbox-sdk";
   import * as dotenv from "dotenv";
   
   dotenv.config();
   
   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" });
   
     console.log(`Android box created: ${box.data.id}`);
   
     // take a screenshot of the box
     await box.action.screenshot({
       path: "screenshot.png",
     });
   
     // terminate the box
     await box.terminate();
   
     console.log("Box terminated");
   }
   
   main();
   

   import os
   from dotenv import load_dotenv
   from gbox_sdk import GboxSDK
   
   # Load environment variables from .env file
   load_dotenv()
   
   def main():
       api_key = os.getenv("GBOX_API_KEY")
   
       gbox = GboxSDK(api_key=api_key)
   
       box = gbox.create(type="android")
   
       print(f"Android box created: {box.data.id}")
   
       # take a screenshot of the box
       box.action.screenshot(path="screenshot.png")
   
       # terminate the box
       box.terminate()
   
       print("Box terminated")
   
   if __name__ == "__main__":
       main()
   
4. Run the box

   Run the box by running the following command in your terminal.

   Typescript

   npx tsx index.ts
   

   python main.py
   

More Android Capabilities

Explore the complete Android API reference to discover all available operations and features.