sandboxes

Create a sandbox

Creates an asynchronously booting sandbox. An identical Idempotency-Key retry returns the same sandbox; changed request fields return 409.

post/api/public/v1/sandboxes

Request

  • Base URL: https://sparkles.dev
  • URL: https://sparkles.dev/api/public/v1/sandboxes
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Request body

promptstring required
modelstring
reasoningEffort'none' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'ultra' | 'ultracode'
titlestring
toolApprovalMode'auto' | 'prompt'
metadataobject

Response

An identical sandbox creation was already accepted

idstring required
worktreeIdstring required
object'sandbox' required
status'queued' | 'creating' | 'running' | 'succeeded' | 'failed' | 'terminating' | 'terminated' required
titlestring required
modelstring nullable required
agentRuntime'opencode' | 'codex' | 'claude' | 'grok' required
metadataobject required
errorstring nullable required
createdAtstring required
startedAtstring nullable required
completedAtstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.