Start a command

Start an asynchronous managed command. The session must be running and may have only one running managed execution. An active provided-agent request reserves the session and blocks external commands. Preserve the returned ID for reconnect or cancellation. Commands mutate the shared session directly. Failed or cancelled commands may leave partial file changes; successful process exit does not establish that every write was flushed durably.

post/v1/sessions/{id}/executions

Request

  • Base URL
    https://assemble-vms-api.fly.dev
  • URL
    https://assemble-vms-api.fly.dev/v1/sessions/{id}/executions
  • Auth
    HTTP bearer

Request body

commandstring required
cwdstring

Working directory within /workspace; defaults to /workspace.

timeoutSecondsinteger
envobject

Per-command guest environment overrides; names must match ^[A-Za-z_][A-Za-z0-9_]*$.

Example request

{
  "command": "pwd"
}

Response

Execution accepted.

idstring uuid required
sessionIdstring uuid required
state'running' | 'completed' | 'failed' | 'cancelled' | 'timed_out' | 'interrupted' required
exitCodeinteger nullable required
createdAtstring date-time required
finishedAtstring date-time nullable required

Changes

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