Sandbox lifecycle

A sandbox starts in the running state. It keeps running until you kill it, its timeout expires, or its lifecycle policy pauses it.

JavaScript uses milliseconds for sandbox timeouts, Python uses seconds, and Go uses time.Duration.

mjs

import { Sandbox } from "@abox-dev/sdk";

const sandbox = await Sandbox.create({ timeoutMs: 60_000 });

try {
  await sandbox.setTimeout(120_000);
  const info = await sandbox.getInfo();
  console.log(`Sandbox ${info.sandboxId} is ${info.state}`);
} finally {
  await sandbox.kill();
}

from agentbox import Sandbox


sandbox = Sandbox.create(timeout=60)

try:
    sandbox.set_timeout(120)
    info = sandbox.get_info()
    print(f"Sandbox {info.sandbox_id} is {info.state}")
finally:
    sandbox.kill()

package main

import (
	"context"
	"fmt"
	"log"
	"time"

	"github.com/abox-dev/sdk/packages/go-sdk"
)

func kill(sandbox *agentbox.Sandbox) {
	if _, err := sandbox.Kill(context.Background()); err != nil {
		log.Printf("cleanup sandbox: %v", err)
	}
}

func run() (err error) {
	ctx := context.Background()
	client, err := agentbox.NewClient()
	if err != nil {
		return err
	}
	sandbox, err := client.Sandboxes.Create(ctx, &agentbox.CreateSandboxOptions{Timeout: time.Minute})
	if err != nil {
		return err
	}
	defer kill(sandbox)

	if err := sandbox.SetTimeout(ctx, 2*time.Minute); err != nil {
		return err
	}
	info, err := sandbox.Info(ctx)
	if err != nil {
		return err
	}
	fmt.Printf("Sandbox %s is %s\n", info.SandboxID, info.State)
	return nil
}

func main() {
	if err := run(); err != nil {
		log.Fatal(err)
	}
}

setTimeout, set_timeout, and SetTimeout start a new timeout from the moment of the call. Use them when the remaining lifetime must become exactly the requested value.

kill permanently removes a running or paused sandbox. A killed sandbox cannot be connected or resumed.

See Persistence to pause a sandbox instead, or open the SDK reference for all options.

Sandbox lifecycle ​

Sandbox lifecycle