Skip to main content
POST
Create a sandbox

Authorizations

Authorization
string
header
required

Access token issued by WorkOS AuthKit.

Body

application/json
name
string
required

Display name of the new sandbox

Required string length: 1 - 100
prompt
string | null

A natural-language description of the scenario the whole sandbox represents. Every twin in it is seeded from this description while it is being provisioned.

Required string length: 1 - 4000
twins
CreateSandboxTwinRequest · object[] | null

Provider twins to provision in the sandbox. Omitted when the sandbox is started from a template, which holds them already.

Required array length: 1 - 5 elements
template
string<uuid> | null

A saved sandbox definition to start from, instead of listing twins. Its twins, their curated scenarios and their instructions are used as they were saved.

save_as_template
boolean
default:false

Also save this sandbox's definition, so another sandbox can be started from it later.

Response

Successful Response

id
string<uuid>
required
slug
string
required
name
string
required
status
string
required
twins
SandboxTwinResponse · object[]
required
created_at
string<date-time>
required
expires_at
string<date-time> | null