Skip to main content
GET
Get a command

Authorizations

Authorization
string
header
required

workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens

Headers

akua-context
string

Optional workspace/scope context for the request. Carries a single workspace wire id (ws_…) today. Only needed for broad tokens - a workspace-owned token implies its workspace.

Required string length: 1 - 53
Example:

"ws_j572abc123def456"

Path Parameters

id
string
required

Sandbox id (sbx_...).

Pattern: ^sbx_[A-Za-z0-9]{1,64}$
Example:

"sbx_j572abc123def456"

command_id
string
required

Sandbox command id (cmd_...).

Pattern: ^cmd_[A-Za-z0-9]{1,64}$
Example:

"cmd_j572abc123def456"

Response

SandboxCommand

id
string
required

Sandbox command id (cmd_...).

Pattern: ^cmd_[A-Za-z0-9]{1,64}$
Example:

"cmd_j572abc123def456"

sandbox_id
string
required

Sandbox id (sbx_...).

Pattern: ^sbx_[A-Za-z0-9]{1,64}$
Example:

"sbx_j572abc123def456"

argv
string[] | null
required
shell
string | null
required
cwd
string
required
timeout_seconds
integer
required
state
enum<string>
required

SUCCEEDED: exited with code 0. FAILED: exited with another code, was killed, or hit its timeout (exit code 124).

Available options:
RUNNING,
SUCCEEDED,
FAILED,
CANCELLED
exit_code
integer | null
required

Set once the command finished.

created_by
object
required
created_at
integer
required

Start time (Unix seconds).

Required range: x >= 0
finished_at
integer | null
required

Finish time (Unix seconds).

Required range: x >= 0
output
object | null
required

Captured output, only on the response to a wait: true request that finished in time; null elsewhere.