Skip to main content
POST
Create a new instance. This kicks off a provisioning process that spins up a cloud sandbox, installs OpenClaw, configures your model provider, and starts the gateway. The endpoint returns immediately with status: "provisioning" — the sandbox takes roughly ~90 seconds to become fully ready. Poll Get Instance Status to know when provisioning completes.
Requires an organization key (chd_org_*). Your org must have an API key configured for the chosen model_provider — set one via Update Organization first.

Request Body

string
required
A name for the instance. 1–128 characters.
string
default:"anthropic"
Which LLM provider to use. Your org must have an API key set for this provider.Options: "anthropic", "openai", "gemini"
string
default:"sandbox"
The cloud sandbox provider. Currently only "sandbox" is supported.
string
default:"v1"
Which OpenClaw version to deploy. Defaults to "v1".
object
Optional config overrides passed to the OpenClaw instance. These are dot-path key/value pairs that get applied via openclaw config set. Useful for tweaking behavior, setting system prompts, etc.
string
Preferred region for the sandbox. If not specified, the default region is used.

Response

Returns 201 Created with the instance object.
string
Unique instance ID (UUID).
string
The owning organization’s ID.
string
Instance name.
string
Current status. Will be "provisioning" immediately after creation. See the overview for all possible states.
string
The configured model provider.
string
The sandbox provider (e.g. "sandbox").
string | null
The underlying sandbox ID. null until provisioning completes.
string | null
Public URL for the OpenClaw gateway. null until provisioning completes.
string
The deployed OpenClaw version.
object | null
Any config overrides applied to this instance.
string | null
The sandbox region, if specified.
string | null
If status is "error", this explains what went wrong.
string
ISO 8601 timestamp.
string
ISO 8601 timestamp.