API Referencesandboxes

Execute command

Execute a command inside a sandbox by name.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

sandbox_namestringRequired

Request

This endpoint expects an object.
commandlist of stringsRequired
Command to execute
workdirstring or nullOptional
Working directory for command execution inside the sandbox
envmap from strings to strings or nullOptional
Environment variables to inject into this execution session
sessionstring or nullOptional

Tmux session name. For POST /exec, creates a detached tmux session (replace semantics - kills any existing session with the same name). For WebSocket /exec, uses attach-or-create semantics (interactive). Ignored for POST /exec/stream.

userstring or nullOptional

User to run the command as (e.g., ‘islo’). If not provided, uses image default.

Response

Successful Response
exec_idstring
statusstring
sandbox_idstring

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error