Gateway API Reference
Full HTTP + WebSocket surface of the OpenVesper gateway. Default bind:127.0.0.1:18789.
Agent execution
| Method | Path | Purpose |
|---|
| POST | /agent | Sync run, returns full reply |
| POST | /agent/async | Async run, returns {runId, acceptedAt} |
| POST | /agent/stream | SSE streaming |
| GET | /agent/run/:runId | Run status |
| POST | /agent/run/:runId/wait | Block until done |
| POST | /agent/run/:runId/abort | Cancel |
Routing & delegation
| Method | Path |
|---|
| POST | /agent/route |
| GET | /agent/routes |
| POST | /agent/delegate |
| POST | /agent/handoff |
| POST | /agent/subagents |
| POST | /agent/:agent/context |
Sessions
| Method | Path |
|---|
| GET | /sessions |
| GET | /sessions/:key |
| POST | /sessions/:key/reset |
| POST | /sessions/:key/agent |
| POST | /sessions/:key/compact |
| GET | /sessions/:key/tokens |
| GET | /sessions/:key/queue |
| POST | /sessions/:key/queue/mode |
| POST | /sessions/:key/fork |
| POST | /sessions/:key/branch |
Tasks, commitments, standing orders, approvals
| Method | Path |
|---|
| GET/POST | /tasks |
| DELETE | /tasks/:id |
| GET/POST | /standing-orders |
| DELETE/toggle | /standing-orders/:id |
| GET/POST | /commitments |
| POST | /commitments/:id/fulfill |
| POST | /commitments/:id/cancel |
| GET | /approvals/pending |
| POST | /approvals/:id/decide |
| GET/POST | /approvals/rules |
| DELETE | /approvals/rules/:index |
Memory
| Method | Path |
|---|
| GET/POST | /memory/:agent |
| POST | /memory/:agent/search |
| DELETE | /memory/:agent/:id |
| DELETE | /memory/:agent (clear all) |
OAuth, audit, diagnostics
| Method | Path |
|---|
| POST | /oauth/start |
| GET | /oauth/tokens |
| GET | /oauth/tokens/:provider |
| DELETE | /oauth/tokens/:provider |
| GET | /audit |
| GET | /audit/stats |
| GET | /audit/dates |
| GET | /diag |
| POST | /diag/export |
Channels, workspaces, remote
| Method | Path |
|---|
| GET/POST | /channel-routes |
| POST | /channel-routes/resolve |
| DELETE | /channel-routes/:index |
| GET/POST | /access |
| POST | /access/check |
| DELETE | /access/:index |
| POST | /remote/instructions |
| GET/POST | /workspaces |
| DELETE | /workspaces/:name |
| GET | /workspaces/:name/env |
Heartbeat & health
| Method | Path |
|---|
| GET | /heartbeat/status |
| POST | /heartbeat/reload |
| GET | /lanes |
| GET | /health |
| WS | /ws |