Skip to main content
REST API over HTTPS. All requests and responses use JSON.

​
Base URL

Versioned REST endpoints live under /api/v1/. The unauthenticated health check is GET /health.

​
Authentication

Bearer token required on all /api/v1/* endpoints. GET /health does not require authentication. See Authentication.

​
Error format

All errors use a standard envelope:
code is stable and safe to match programmatically. message is human-readable and may change.

​
Status codes

​
Rate limiting

Per-organization, per-minute window. 429 responses include a Retry-After header.

​
Versioning

Versions are in the URL path (/api/v1/). Breaking changes ship under a new version. Additive fields may be added to existing versions without notice.

​
Health check

No authentication required.