Sandboxes

Create a sandbox

Changed on
post/api/v0beta1/sandboxes

Request

  • Base URL
    https://app.amika.dev (the document declares no server; this is the origin it was published from)
  • URL
    https://app.amika.dev/api/v0beta1/sandboxes
  • Auth
    • HTTP bearer
    • or API key in cookie wos-session

Request body

namestring required
repo_urlstring
git_urlstring
github_urlstring
branchstring
new_branch_namestring
provider'daytona' | 'e2b' | 'freestyle' | 'vercel' | 'smol' | 'amika-hostd'
host_idstring
auto_stop_intervalnumber
auto_delete_intervalnumber
env_varsobject
secret_env_varsobject
disabled_repo_env_var_namesstring[]
setup_script_textstring
skip_setup_scriptboolean
preset'coder' | 'coder-plus-docker'
sizestring

Providerless sandbox size (for example a0.m). Legacy names such as m and medium are also accepted. The provider is inferred from provider or the server default; when omitted, the size defaults to that provider's medium tier. With host_id, names one of the host's own sizes instead; a host rig with neither size nor resources gets 4 vCPUs, 8 GiB of memory and a 20 GiB disk.

snapshotstring nullable
integration_idsstring[]
agent'claude' | 'codex'
github_auth_mode'pat' | 'app_token'

Response

Sandbox created (provisioning continues in the background).

idstring required
user_idstring nullable required
org_idstring required
namestring required
providerstring nullable required
provider_sandbox_idstring nullable required
amika_opencode_webstring nullable required
repo_namestring nullable required
repo_providerstring nullable required
repo_idstring nullable required
repo_urlstring nullable required
branchstring nullable required
commit_hashstring nullable required
snapshotstring nullable required
snapshot_namestring nullable
sandbox_presetstring nullable
sandbox_sizestring nullable
github_auth_mode'pat' | 'app_token' | 'null' nullable
github_credential_provisionedboolean nullable
error_messagestring nullable
current_session_idstring nullable required
statestring
status'creating' | 'starting' | 'running' | 'stopping' | 'stopped' | 'suspending' | 'suspended' | 'snapshotting' | 'failed' | 'unknown'
setup_status'ok' | 'setup-running' | 'git-failed' | 'setup-failed' | 'sys-setup-failed' | 'null' nullable
live_state_pendingboolean
secret_namesstring[]
agent_cwdstring nullable
ssh_key_status'ready' | 'no-key' | 'stale-keys' | 'unknown'
originstring nullable
host_idstring nullable

Changes