Skip to main content
A box starts from an image. Pick the one that already has your runtime rather than installing it on every start.

Prerequisites

  • An API key from the console, exported as BOXLITE_API_KEY. See API keys.
  • pip install boxlite, and the REST URL exported as BOXLITE_REST_URL. See Quickstart.

Choose an image

The New Box dialog offers three images: From code you pass an image reference instead. The official SDK examples use ghcr.io/boxlite-ai/boxlite-agent-base:v0.1.0, and that is the image to start from when you have no reason to pick another:
An API key carries the Boxes permission, and the console describes what that includes:
Boxes API access — This key can create and manage Boxes. Shared Linux base images are available automatically.
So you do not stage or pull a base image before your first create. Image operations such as pulling are not supported over the REST runtime — see Cloud vs open source.

Next steps

Boxes

Everything else about configuring a box on Cloud.