Skip to main content
POST
Register a new agent from a source zip and queue an asynchronous

Body

multipart/form-data

Multipart form for POST /agents/upload — a .zip source/file field (an AgentCard.json + Dockerfile package) plus agent metadata fields.

name
string
required
source
file
required
env
string | null

JSON object of extra env vars, e.g. {"FOO":"bar"}.

inbound_format
string | null

openai (default) | anthropic | gemini — which SDK the agent's code speaks.

ports
string | null

Comma-separated container ports (defaults to 8000).

version_tag
string | null
writable
string | null

"true"/"false" to mount / not mount a persistent, private-per-agent directory at /workspace. Tri-state: omit the field to keep an existing agent's stored setting (false for a new agent) — the CLI only sends it when --writable was passed.

writable_path
string | null

Container-side mount target for the writable volume (--writable-path). Absolute path; implies writable. Omit to keep an existing agent's stored path (/workspace for a new agent).

Response

Build queued

data
object
required
message
string
required
status_code
integer<int32>
required
Required range: x >= 0