agents
Start an asynchronous install for one fixed agent harness
post/api/v1/agents/{agent}/install
Path parameters
agentstring required
Agent adapter identifier.
Agent adapter identifier.
Request body
methodstring
Server-issued installation method id. Omit to use the recommended viable method.
operation'install' | 'reinstall'
Requested operation. Defaults to install for older clients.
Response
Accepted
commandstring
Human-readable install command, e.g. "brew install tmux", for display even before/without output.
errorstring
Set on failure or when the target is unsupported on this machine: the exec error, the Unsupported reason, or a timeout message.
expectedDestinationstring
Expected or adapter-resolved executable destination.
finishedAtstring date-time nullable
Absent until the job finishes.
methodstring
Server-owned installation method selected for this harness job.
outputstring
Combined stdout+stderr from the install command, tail-capped to the last ~4000 bytes.
startedAtstring date-time nullable
status'idle' | 'running' | 'installing' | 'verifying' | 'succeeded' | 'failed' | 'unsupported' | 'interrupted' required
Current lifecycle state of the job.
target'tmux' | 'gh' | 'claude' | 'claude-code' | 'codex' | 'cursor' | 'opencode' | 'aider' | 'copilot' | 'grok' | 'kimi' | 'pi' | 'amp' | 'auggie' | 'droid' | 'crush' | 'cline' | 'goose' | 'qwen' | 'continue' | 'devin' | 'kiro' | 'kilocode' | 'vibe' | 'muse' | 'agy' | 'autohand' | 'kimchi' | 'prime-agent' | 'omp' | 'unreal-agent' | 'cloudflared' required
Fixed install target this job ran (or is running) for.
updatedAtstring date-time nullable