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: "linux" });
console.log(`Linux box created: ${box.data.id}`);
}
main();import os
from gbox_sdk import GboxSDK
gbox_sdk = GboxSDK(api_key=os.environ["GBOX_API_KEY"])
box = gbox_sdk.create(type="linux")
print(f"Linux box created: {box.data.id}")curl --request POST \
--url https://gbox.ai/api/v1/boxes/linux \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"wait": true,
"timeout": "30s",
"config": {
"labels": {
"project": "web-automation",
"environment": "testing"
},
"envs": {
"DEBUG": "true",
"API_URL": "https://api.example.com"
},
"expiresIn": "60m"
}
}
'{
"id": "c9bdc193-b54b-4ddb-a035-5ac0c598d32d",
"status": "running",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:35:00.000Z",
"expiresAt": "2024-01-15T10:40:00.000Z",
"type": "linux",
"config": {
"os": {
"version": "ubuntu-20.04"
},
"deviceType": "physical",
"workingDir": "/home/user",
"labels": {
"environment": "development",
"team": "qa"
},
"envs": {
"NODE_ENV": "production",
"PATH": "/usr/bin:/bin"
},
"cpu": 2,
"memory": 1024,
"storage": 30
},
"reason": "Box terminated by user"
}Create linux box
Provisions a new Linux box that you can operate through the GBOX SDK. Use this endpoint when you want to create a fresh Linux environment for testing, automation, or agent execution.
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: "linux" });
console.log(`Linux box created: ${box.data.id}`);
}
main();import os
from gbox_sdk import GboxSDK
gbox_sdk = GboxSDK(api_key=os.environ["GBOX_API_KEY"])
box = gbox_sdk.create(type="linux")
print(f"Linux box created: {box.data.id}")curl --request POST \
--url https://gbox.ai/api/v1/boxes/linux \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"wait": true,
"timeout": "30s",
"config": {
"labels": {
"project": "web-automation",
"environment": "testing"
},
"envs": {
"DEBUG": "true",
"API_URL": "https://api.example.com"
},
"expiresIn": "60m"
}
}
'{
"id": "c9bdc193-b54b-4ddb-a035-5ac0c598d32d",
"status": "running",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:35:00.000Z",
"expiresAt": "2024-01-15T10:40:00.000Z",
"type": "linux",
"config": {
"os": {
"version": "ubuntu-20.04"
},
"deviceType": "physical",
"workingDir": "/home/user",
"labels": {
"environment": "development",
"team": "qa"
},
"envs": {
"NODE_ENV": "production",
"PATH": "/usr/bin:/bin"
},
"cpu": 2,
"memory": 1024,
"storage": 30
},
"reason": "Box terminated by user"
}Authorizations
Enter your API Key in the format: Bearer . Get it from https://gbox.ai
Body
Request body for creating a new Linux box instance
Wait for the box operation to be completed, default is true
true
Timeout for waiting the box to transition from pending to running state, default is 30s. If the box doesn't reach running state within this timeout, the API will return HTTP status code 408. The timed-out box will be automatically deleted and will not count towards your quota.
Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: "500ms", "30s", "5m", "1h" Default: 30s Maximum allowed: 5m
"30s"
Configuration for a Linux box instance
Show child attributes
Show child attributes
{
"labels": {
"project": "web-automation",
"environment": "testing"
},
"envs": {
"DEBUG": "true",
"API_URL": "https://api.example.com"
},
"expiresIn": "60m"
}
Response
Linux box instance with full configuration and status
Unique identifier for the box
"c9bdc193-b54b-4ddb-a035-5ac0c598d32d"
The current status of a box instance
pending, running, error, terminated "running"
Creation timestamp of the box
"2024-01-15T10:30:00.000Z"
Last update timestamp of the box
"2024-01-15T10:35:00.000Z"
Expiration timestamp of the box
"2024-01-15T10:40:00.000Z"
Box type is Linux
linux "linux"
Configuration for a Linux box instance
Show child attributes
Show child attributes
{
"os": { "version": "ubuntu-20.04" },
"deviceType": "physical",
"workingDir": "/home/user",
"labels": {
"environment": "development",
"team": "qa"
},
"envs": {
"NODE_ENV": "production",
"PATH": "/usr/bin:/bin"
},
"cpu": 2,
"memory": 1024,
"storage": 30
}
The reason for the current status, if any
"Box terminated by user"
Was this page helpful?