API Endpoints

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

MethodEndpointDescription
GET/api/health/ping/Public health check
GET/api/health/whoami/Authenticated caller metadata
GET/api/master/Current account owner metadata

Authentication

MethodEndpointDescription
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

MethodEndpointScope
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

MethodEndpointDescription
GET / POST/api/identities/List or create identities
GET / PUT / PATCH / DELETE/api/identities/<uuid>/Read, update, or delete an identity

Email

MethodEndpointDescription
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

MethodEndpointDescription
GET / POST/api/domains/List or create domains
GET / PUT / PATCH / DELETE/api/domains/<id>/Domain detail

Phone And SMS

MethodEndpointDescription
GET / POST/api/phone/Phone number resources
GET / PUT / PATCH / DELETE/api/phone/<id>/Phone number detail
GET/api/sms-inbox/SMS conversations
GET/api/sms-inbox/<conversation-id>/SMS conversation detail
GET / POST/api/messages/SMS messages
GET / PUT / PATCH / DELETE/api/messages/<id>/SMS message detail
POST/api/messages/send/Send SMS
GET / POST/api/calls/Phone call resources
GET / PUT / PATCH / DELETE/api/calls/<id>/Phone call detail
POST/api/webhook/telnyx/Telnyx webhook
POST/api/webhook/twilio/Twilio webhook
POST/api/webhook/voipms/VoIP.ms webhook

Contacts

MethodEndpointDescription
GET / POST/api/contacts/List or create contacts
GET / PUT / PATCH / DELETE/api/contacts/<id>/Contact detail

Passwords And Secrets

MethodEndpointDescription
GET / POST/api/passwords/List or create password entries
GET / PUT / PATCH / DELETE/api/passwords/<uuid>/Password entry detail
GET/api/passwords/generate_password/Generate a password
GET / POST/api/secrets/List or create secret entries
GET / PUT / PATCH / DELETE/api/secrets/<uuid>/Secret entry detail

Webhooks And Events

MethodEndpointDescription
GET / POST/api/webhook-subscriptions/Customer webhook endpoints
GET / PUT / PATCH / DELETE/api/webhook-subscriptions/<id>/Customer webhook endpoint detail
GET/api/webhook-deliveries/Webhook delivery logs
GET/api/webhook-deliveries/<id>/Webhook delivery detail
GET/api/events/Event replay endpoint

Billing

MethodEndpointDescription
GET/api/subscription/Current subscription status