zinn-agents
POST /v1/agents
Deploy one agent app on a free Zinn® Agents plan slot.
Authentication
Send an API key as a bearer token. The key must carry the agents.manage permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/agents \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "app": <string> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Gated on agents.manage. Binds the app to one free slot (the named slot_id, or the oldest free one) and starts the durable provisioning workflow; the agent answers provisioning until its pod is ready, then running. Refused with 402 NO_PLAN when there is no free slot, 409 PLAN_TOO_SMALL when the plan's memory is below the app's minimum, 409 TOO_MANY at the per-organisation ceiling, 403 NOT_OPEN while the product is off for the account, and 400 UNKNOWN_APP (n8n is never offered here — its licence allows it only on the customer's own Private Cloud server). The agent is created in org_id (or the X-Zinn-Org the dashboard sends); with neither, only a caller in a single organisation can deploy — a caller in several gets 404 rather than a guess.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | Uuid | No | The organization this call acts on. Optional for a caller with exactly one direct membership; required for anyone with more than one — which is every reseller and every agency… |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
app | string | Yes | — |
name | string | No | — |
slot_id | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
org_id | string | Yes | — |
name | string | Yes | — |
app | string<openclaw, hermes, paperclip, activepieces> | Yes | — |
status | string<provisioning, running, suspended, failed, deleting, deleted> | Yes | — |
status_detail | string | Yes | — |
suspend_reason | string<, standing, customer, ended, staff> | Yes | — |
plan_code | string | Yes | — |
paid_by | string<subscription, trial> | Yes | — |
resources | AgentResources | Yes | — |
url | string | Yes | — |
model | string | Yes | — |
monthly_cap_micros | integer | Yes | — |
spent_period_micros | integer | Yes | — |
created_at | string | Yes | — |
provisioned_at | string | Yes | — |
Errors this endpoint can return
400 · 401 · 402 · 403 · 409 · 503