Introduction
What is Ravi?
Ravi gives AI agents isolated communication and credential surfaces: identities, email inboxes, phone numbers, contacts, API keys, webhooks, passwords, and secrets.
The important product boundary is simple:
- The backend API runs at
https://api.ravi.app. - The dashboard runs separately from this docs site.
- Public API docs live here on
docs.ravi.app. - Machine-readable API reference is published at
https://docs.ravi.app/openapi.json.
Start Here
| Goal | Read |
|---|---|
| Sign up and create an identity | Sign Up |
| Your agent hit a login wall | Your agent hit a login wall |
| When an agent needs its own identity | When to Use |
| Signup OTP / magic link | Signup OTP |
| Give the agent an email so it can sign up | Give the agent an email so it can sign up |
| The site texted a code and the agent has no phone | The site texted a code and the agent has no phone |
| Returning-login 2FA | Returning Login 2FA |
| Passwords across worktrees | Credentials Across Worktrees |
| The agent made a password yesterday and this chat does not have it | The agent made a password yesterday and this chat does not have it |
| How an agent signs up for a website | How an agent signs up for a website |
| Understand auth | Authentication |
| See the API shape | API Overview |
| Find endpoint groups | API Endpoints |
| Use the OpenAPI contract | API Reference |
| Use a first-party client | SDK Overview |
| Use email | |
| Use phone and SMS | Phone & SMS |
| Store passwords and secrets | Credential Vault |
| Install the CLI | Installation |
Core Concepts
An Identity is the scoped persona an agent operates as. Identity-scoped API keys and requests can only operate on the resources available to that identity.
An identity can own communication resources:
Identity
├── Email inbox
├── Phone number
├── Contacts
├── Password entries
└── Secret entries
Ravi also supports management-level keys for account or workspace operations, plus identity-level keys for agent runtime work.
The CLI is one identity per machine (~/.ravi/config.json is not a multi-agent runtime). Multiple agents on one host use the HTTP API with per-identity ravi_id_... keys, or the Cursor Connect plugin.
Machine-Readable Docs
Use these text endpoints when handing Ravi docs to an agent:
curl https://docs.ravi.app/llms.txt
curl https://docs.ravi.app/llms-full.txt
/llms.txt is a compact index. /llms-full.txt includes the full markdown body for every public docs page.
Every docs HTML page also has a plain-text sibling. For example:
https://docs.ravi.app/api/reference.txt
https://docs.ravi.app/sdk/typescript.txt
https://docs.ravi.app/sdk/python.txt
https://docs.ravi.app/core-concepts/identities.txt