Base URL
http://localhost:3001 when developing against a local instance.
Surfaces
| Prefix | Surface | Auth |
|---|---|---|
/api/v1/* | Public v1 — executives, agents, sessions, webhooks, organization | API key |
/api/v2/* | Public v2 — governance, analytics, agent execution | API key |
Conventions
- Authentication —
Authorization: Bearer YOUR_API_KEYon every request. See Authentication. - Content type — request and response bodies are JSON.
- Pagination — list endpoints are paginated; follow the returned cursors.
- Errors — a consistent envelope with a machine-readable
code. See Authentication → Errors. - Idempotency — retried
5xxfailures are safe for idempotent operations.
Quickstart
New here? Make your first call in five minutes.