Skip to main content
The Agentbox SDK is a thin client for the GMI Agentbox API. Use it to launch sandboxes, run commands, move files, open a shell, pause and resume, and launch many sandboxes from a snapshot.

Install

Core objects

Typical flow

  1. Create an Agent from a container image and wait for the image build to finish.
  2. Launch a sandbox from the Agent and wait until it is running.
  3. Run commands, transfer files, or open a shell.
  4. Pause the sandbox to stop run time, or save a snapshot to launch more sandboxes from the same state.
  5. Delete your sandboxes when you are done, then delete the Agent.
Sandboxes bill your Console account while they run. Always delete the sandboxes you launch in tests.

Next steps

Quickstart

Launch your first sandbox and run a command.

Agents and image builds

Define what a sandbox runs and follow its image build.

Sandboxes

Launch, label, pause, resume and delete sandboxes.

Commands and files

Run commands and move files in and out.

Snapshots

Save a sandbox and launch many from it.