Quick Start

Get started with the GBOX SDK to create and manage virtual devices

Installation

Install the GBOX SDK using your preferred package manager:

npm

npm install gbox-sdk

pnpm install gbox-sdk

yarn add gbox-sdk

Basic Usage

1. Initialize the SDK

First, import and initialize the SDK with your API key for authentication:

Basic Setup

import GboxSDK from "gbox-sdk";

const gboxSDK = new GboxSDK({
  apiKey: process.env["GBOX_API_KEY"], // Recommended: use environment variables
});

import GboxSDK from "gbox-sdk";

const gboxSDK = new GboxSDK({
  apiKey: process.env["GBOX_API_KEY"],
  baseURL: "https://gbox.ai/api/v1", // Optional: custom API base URL
  timeout: 60 * 1000, // Optional: request timeout in milliseconds
  maxRetries: 0, // Optional: maximum number of retries
});

2. Create Virtual Devices

Use the SDK to create different types of virtual devices:

Android Device

async function createAndroidBox() {
  try {
    const box = await gboxSDK.create({
      type: "android",
      // Optional: add other configuration parameters
    });

    console.log("Android device created successfully:", box.id);
    return box;
  } catch (error) {
    console.error("Failed to create Android device:", error);
  }
}

createAndroidBox();

async function createLinuxBox() {
  try {
    const box = await gboxSDK.create({
      type: "linux",
    });

    console.log("Linux device created successfully:", box.id);
    return box;
  } catch (error) {
    console.error("Failed to create Linux device:", error);
  }
}

createLinuxBox();

3. Complete Example

Here’s a complete example showing how to create a device and perform basic operations:

import GboxSDK from "gbox-sdk";

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

async function main() {
  try {
    // Create an Android device
    const box = await gboxSDK.create({ type: "android" });
    console.log(`Device created successfully, ID: ${box.id}`);

    // Start the device
    await gboxSDK.startBox({ id: box.id });
    console.log("Device started successfully");

    // Wait for device to be ready...

    // Stop the device
    await gboxSDK.stopBox({ id: box.id });
    console.log("Device stopped");
  } catch (error) {
    console.error("Operation failed:", error);
  }
}

main();

Next Steps

• Learn how to configure custom base URLs
• Understand timeout settings and retry mechanisms
• Explore the complete TypeScript SDK documentation