API Reference
The OpenAPI document is generated from the running application and is the
authoritative source. These pages describe the endpoints you need in practice.
Conventions
- Auth:
Authorization: Bearer vk_live_… — see Authentication.
- Timestamps: Unix epoch seconds, as floats.
{project_id} in a path is your project key, not the internal proj_… id.- Errors:
{"detail": "..."} — see Errors.
Endpoint map
Context and memory
Projects and organization
Auth and keys
| Method |
Path |
POST |
/api/auth/register |
POST |
/api/auth/login · /api/auth/logout |
GET |
/api/auth/me |
POST GET |
/api/auth/api-keys |
DELETE |
/api/auth/api-keys/{key_id} |
POST |
/api/auth/api-keys/{key_id}/rotate |
POST |
/api/auth/forgot-password · /api/auth/reset-password |
GET |
/api/auth/oauth/providers · /api/auth/oauth/{provider} |
→ Authentication
| Method |
Path |
Page |
GET |
/api/health · /health |
Health API |
GET |
/api/usage · /api/activity · /api/onboarding |
— |
POST |
/api/feedback · /api/telemetry |
— |
Not covered here
These exist and are reachable, but are dashboard-facing, experimental, or both.
They are listed so you know they are not omissions:
| Path |
Status |
/api/security/analyze |
Experimental |
/api/handoffs |
Experimental |
/api/members · /api/invitations |
Beta — team management, dashboard session required |
/api/dashboard/summary |
Beta — shape follows the dashboard's needs |
/api/billing |
Beta |
/api/user/preferences |
Beta |
Consult /openapi.json for their exact
schemas rather than relying on prose that may lag behind them.
Rate limits
Enforced only when the server runs with VENKAI_ENV=production, per client IP,
60-second window:
| Caller |
Limit |
| Authenticated |
300 req/min |
| Anonymous |
60 req/min |
Over the limit: 429 with Retry-After in seconds.