API Reference
Complete REST API and WebSocket protocol reference for EdgeBase. All endpoints are available at your project's base URL.
Base URL
https://your-project.edgebase.dev/api/
API Groups
| Group | Base Path | Description |
|---|---|---|
| Authentication | /api/auth/* | Sign up, sign in, OAuth, token refresh, password reset |
| Database | /api/db/{namespace}/{id?}/{table} | CRUD, batch, queries, count |
| Storage | /api/storage/{bucket}/* | Upload, download, signed URLs, multipart |
| Realtime | /api/realtime | WebSocket connection for subscriptions, presence, broadcast |
| Room | /api/room | WebSocket connection for multiplayer rooms |
| Push | /api/push/* | Device registration, topic management |
| Functions | /api/functions/* | HTTP-triggered App Functions |
| Admin | /api/auth/admin/* | User management (requires Service Key or Admin JWT) |
| Native Resources | /api/kv/*, /api/d1/*, /api/vectorize/* | Direct KV, D1, Vectorize access |
| System | /api/health, /api/status | Health check and system info |
Authentication
Most endpoints require a JWT access token:
Authorization: Bearer <access_token>
Admin endpoints additionally require a Service Key:
X-EdgeBase-Service-Key: <service_key>
Next Steps
| Page | Description |
|---|---|
| Authentication API | Auth endpoints (signup, signin, OAuth, refresh) |
| Database API | CRUD, batch, query, count endpoints |
| Storage API | File upload, download, signed URL endpoints |
| Realtime API | WebSocket protocol for subscriptions |
| Room API | WebSocket protocol for multiplayer rooms |
| Push API | Push notification endpoints |
| Functions API | HTTP function endpoints |
| Admin API | Admin user management endpoints |
| Native Resources API | KV, D1, Vectorize endpoints |
| System API | Health check and status |