zinn-agents
POST /v1/agents/{agentId}/pause
Pause an agent (its data is kept; it stops using compute and AI).
Authentication
Send an API key as a bearer token. The endpoint checks agents.manage, agents.view; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
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/{agentId}/pause \
-H "Authorization: Bearer zdk_live_…"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
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
agentId (path) | string | Yes | — |
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
401 · 404