Quickstart

This guide will show you how to create your first box.

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

   Install the GBOX SDK to your project by running the following command in your terminal.

   Typescript

   npm install gbox-sdk dotenv
   

   # Set up a virtual environment
   python3 -m venv venv
   source venv/bin/activate
   
   pip install gbox-sdk dotenv
   
3. Use the GBOX SDK to create and control environments for your AI agents

   Sample: Create a Linux box capable of running python code.

   Typescript

   import GboxSDK from "gbox-sdk";
   import * as dotenv from "dotenv";
   
   dotenv.config();
   
   const gboxSDK = new GboxSDK();
   
   async function main() {
     const myBox = await gboxSDK.create({ type: "linux" });
   
     console.log(`Linux box created: ${myBox.data.id}`);
   
     const result = await myBox.runCode({
       code: `print("Hello from Python!")`,
       language: "python"
     })
   
     console.log("Python execution result:");
     console.log(result)
   }
   
   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")
       # Initialize GboxSDK
       gbox = GboxSDK(api_key=api_key)
       # Create a Linux box
       box = gbox.create(type="linux")
       print(f"Linux box created: {box.data.id}")
       # Run Python code in the box
       result = box.run_code(
           code='print("Hello from Python!")',
           language="python"
       )
       print("Python execution result:")
       print(result)
   
   if __name__ == "__main__":
       main()
   

   See the API Reference for details.

4. Run the code

   Typescript

   npx tsx ./index.ts
   

   python ./main.py