API reference
zinn-agents
9 endpoints in this area. Each one has its own page with its parameters, its response and a request you can run.
| Method | Path | What it does | Permission |
|---|---|---|---|
| POST | /v1/agent-gateway/chat/completions | OpenAI-compatible chat completions for an agent app, metered on Zinn® AI credit. | No API key |
| GET | /v1/agent-gateway/models | The models an agent may name (OpenAI list shape). | No API key |
| GET | /v1/agents | The organisation's agents, free plan slots, apps and plans. | agents.view |
| POST | /v1/agents | Deploy one agent app on a free Zinn® Agents plan slot. | agents.manage |
| DELETE | /v1/agents/{agentId} | Delete an agent and destroy its data volume. | agents.manage, agents.view |
| GET | /v1/agents/{agentId} | One agent. | agents.view |
| PATCH | /v1/agents/{agentId} | Rename an agent, choose its model, or set its monthly AI spend cap. | agents.manage |
| POST | /v1/agents/{agentId}/pause | Pause an agent (its data is kept; it stops using compute and AI). | agents.manage, agents.view |
| POST | /v1/agents/{agentId}/resume | Resume a paused agent. | agents.manage, agents.view |