Skip to main content
POST
Start a sandbox

Authorizations

Authorization
string
header
required

API token created in the Thunder console.

Body

application/json

Resources, lifetime, network policy, environment, and immutable SSH key.

spec
object
required

GPU type and count must be supplied together. Supported types and ranges depend on the organization's sandbox configuration.

lifetime
object
required
network_policy
object
required
ssh_public_key
string
required

One-line OpenSSH public key. It cannot be replaced after creation.

name
string

Optional display label. It must be unique among live sandboxes and cannot be used in place of the ID. It must be printable, have no leading or trailing whitespace or slash, and cannot be ., .., or a value surrounded by double underscores.

Maximum string length: 64
env
object

Environment variables installed for SSH sessions.

Response

Startup accepted.

id
string
required

Permanent identifier for every later request.

Example:

"sbx-0123456789abcdef"

name
string
required

Display label, or the ID when no name was supplied.

Example:

"training-run"