zinn-agents
POST /v1/agents/{agentId}/login
Show how to sign in to the agent app (its token or password).
Authentication
Send an API key as a bearer token. The key must carry the agents.login.reveal permission; 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}/login \
-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
Details
Gated on agents.login.reveal — its own permission, held by the organisation OWNER only (not dev, not any read role), because the secret opens the agent and everything it is connected to. Every call is audit-logged as agent.login_revealed; the audit row and the logs carry no part of the secret. The secret is recomputed from the agent id on each call and stored nowhere. method is password (Hermes: username + secret — a backup; the Open button already signs in), open (OpenClaw: no secret exists — our sign-in check in front of the agent signs the owner in from openAgent), app_account (Paperclip, Activepieces: the app has its own account sign-up on first visit; no secret), or token (an app that reads its token from a URL fragment; none today). Refused with 409 LOGIN_PAUSED while the agent is paused and 402 LOGIN_UNPAID while its plan is not in good standing. ⛔ A POST rather than a GET on purpose: a GET would put the credential in browser history and proxy logs. The response is Cache-Control: no-store.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
agentId (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
method | string<token, password, app_account, open> | Yes | — |
url | string | Yes | The agent's public address. |
username | string | Yes | Set for password only. |
secret | string | Yes | The token (token) or password (password); null for app_account and open. |
open_url | string | Yes | Opens the app signed in where the app reads its token from a URL fragment (token: url + /#token=…); otherwise url. To open an agent signed in, use openAgent. |
Errors this endpoint can return
401 · 402 · 403 · 404 · 409