Skip to main content
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.
npm 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.
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();
See the API Reference for details.
4

Run the code

npx tsx ./index.ts