Ravi

Quickstart

1. Check The Backend

curl https://api.ravi.app/api/health/ping/

You should receive a JSON response from the production Django backend.

2. Choose Authentication

For agent runtimes, use the narrowest API key that works:

  • ravi_id_... for one identity
  • ravi_mgmt_... for management operations

Pass the key as a bearer token:

export RAVI_API_KEY="ravi_id_..."

curl https://api.ravi.app/api/health/whoami/ \
  -H "Authorization: Bearer $RAVI_API_KEY"

For local CLI login, use:

ravi auth login

3. Inspect Available Resources

Once authenticated, list the resources you need:

# Account-level: list the identities the key can reach.
curl https://api.ravi.app/api/identities/ \
  -H "Authorization: Bearer $RAVI_API_KEY"

# Per-identity: the caller chooses the identity via ?identity=<uuid>.
curl "https://api.ravi.app/api/email-inbox/?identity=$IDENTITY_UUID" \
  -H "Authorization: Bearer $RAVI_API_KEY"

curl "https://api.ravi.app/api/sms-inbox/?identity=$IDENTITY_UUID" \
  -H "Authorization: Bearer $RAVI_API_KEY"

The API key is an auth fence only — the caller picks the identity. A management key with ?identity=<uuid> targets one identity; an identity-scoped key is already fenced to its identity, and ?identity=<uuid> must match it.

4. Use The API Reference

Use API Endpoints as the route map and https://docs.ravi.app/openapi.json for generated request and response schemas.

Next Steps