This page is a route-family map. For exact request and response fields, use the generated OpenAPI document at https://docs.ravi.app/openapi.json.
Per-identity route families (Email, Phone & SMS, Contacts, Passwords, Secrets, and per-identity Events) accept an explicit ?identity=<uuid> query parameter. The API key is only an auth fence; the caller chooses the identity. With a management key the param targets one identity; with an identity-scoped key it must match the key’s fenced identity. See API Overview → Identity Scoping.
System And Health
Method
Endpoint
Description
GET
/api/health/ping/
Public health check
GET
/api/health/whoami/
Authenticated caller metadata
GET
/api/master/
Current account owner metadata
Authentication
Method
Endpoint
Description
POST
/api/auth/login/
Login
POST
/api/auth/logout/
Logout
GET
/api/auth/user/
Current authenticated user
POST
/api/auth/token/refresh/
Refresh a JWT
POST
/api/auth/token/verify/
Verify a JWT
POST
/api/auth/device/
Start device-code login
POST
/api/auth/device/token/
Poll device-code login
GET / POST
/api/auth/device/verify/
Verify a device code
GET
/api/auth/device/callback/
Complete device-code OAuth callback
POST
/api/auth/bind-identity/
Bind auth flow to an identity
POST
/api/auth/social/google/
Google OAuth exchange
API Keys
Method
Endpoint
Scope
GET / POST
/api/auth/keys/management/
Management keys, ravi_mgmt_...
GET / DELETE
/api/auth/keys/management/<id>/
Management key detail/revoke
GET / POST
/api/auth/keys/identity/
Identity keys, ravi_id_...
GET / DELETE
/api/auth/keys/identity/<id>/
Identity key detail/revoke
Identities
Method
Endpoint
Description
GET / POST
/api/identities/
List or create identities
GET / PUT / PATCH / DELETE
/api/identities/<uuid>/
Read, update, or delete an identity
Email
Method
Endpoint
Description
GET / POST
/api/email/
Email inbox resources
GET / PUT / PATCH / DELETE
/api/email/<id>/
Email inbox detail
GET
/api/email-inbox/
Thread-oriented inbox listing
GET
/api/email-inbox/<thread-id>/
Thread detail
GET / POST
/api/email-messages/
List or create email messages
GET / PUT / PATCH / DELETE
/api/email-messages/<id>/
Email message detail
POST
/api/email-attachments/presign/
Create a presigned upload target
POST
/api/webhook/email/inbound/
Generic inbound email webhook
POST
/api/webhook/email/sendgrid-inbound/
SendGrid inbound parse webhook
Domains
Method
Endpoint
Description
GET / POST
/api/domains/
List or create domains
GET / PUT / PATCH / DELETE
/api/domains/<id>/
Domain detail
Phone And SMS
Outbound SMS is paused — POST /api/messages/send/ returns HTTP 403 with code outbound_sms_paused. Inbound receive still works.