API Reference
Waypath's REST + WebSocket API is the core product. The dashboard is one consumer; you can build your own integrations using these endpoints.
For external agents, the canonical public surface is the capability gateway. Use it for API, CLI, and MCP-backed workflows so grants, modes, quota, idempotency, AOS approval, receipts, and audit history stay consistent.
01Base URL
https://api.waypath.app
If your client supports it, point it at any base URL via env var or SDK config so you can target staging, a self-hosted instance, or a local proxy without hard-coding.
02Authentication
All endpoints (except health check) require authentication via one of:
- JWT token:
Authorization: Bearer <token>(for dashboard users) - API key:
X-API-Key: wp_live_...(for external consumers)
See Authentication for details.
03Endpoints
| Section | Endpoints |
|---|---|
| Authentication | Register, login, session, API key management |
| Capabilities | Discover, invoke, meter, and inspect agent capabilities |
| Event Ingestion | Track events, identify customers, batch ingestion |
| Customers | List, get, timeline, dedupe |
| Intelligence Data | Full intelligence export, Cypher queries |
| Webhooks | Inbound platform webhooks |
| WebSocket | Real-time intelligence update stream |
| Playbooks | CRUD + run tracking for executable agent specs |
| Reporting | KPI summary + recent agent reasoning feed |
| Brand Context | Per-workspace business + voice profile |
04Response format
All endpoints return JSON. Successful responses use standard HTTP status codes
(200, 201). Errors return { error: string } with appropriate 4xx/5xx codes.