# Revve AI

## Docs

- [Welcome to Revve AI](https://www.revve.ai/docs/introduction.md): Build AI-powered chat and voice agents that handle customer conversations across every channel — start here to find the docs for your role.
- [Quickstart: Live Agent in 10 Minutes](https://www.revve.ai/docs/getting-started/quickstart.md): Go from zero to a working AI agent answering real visitors on your website — create, test, publish, and install in about 10 minutes.
- [Publishing & Versioning (Chat Agents)](https://www.revve.ai/docs/getting-started/publishing-and-versioning.md): How drafts, publishing, and version history keep your live Chat Agent safe while you iterate.
- [Ask Revve: Your In-App Copilot](https://www.revve.ai/docs/ask-revve/ask-revve-overview.md): For every Revve user: chat with the built-in copilot to analyze calls, create agents and campaigns, and propose prompt changes — with a review-and-apply safety net for app owners.
- [What Can Ask Revve Do?](https://www.revve.ai/docs/ask-revve/what-can-ask-revve-do.md): The complete capability catalog for anyone who works in the Revve dashboard: everything you can ask the copilot to look up, create, or propose — with copy-paste example prompts — and a clear list of what it will never do.
- [Skills for Ask Revve](https://www.revve.ai/docs/ask-revve/skills.md): How team members who use the Ask Revve copilot write, scope, and share skills — reusable markdown instructions that make the copilot follow the same playbook every time.
- [Build a Lead Qualification Agent That Books Meetings](https://www.revve.ai/docs/guides/lead-qualification-agent.md): A complete, copy-paste recipe: a website agent that qualifies visitors, captures their contact details, books meetings on your calendar, and hands hot leads to your team.
- [Build a Payment Reminder Campaign (Voice + SMS Fallback)](https://www.revve.ai/docs/guides/payment-reminder-campaign.md): A complete, copy-paste recipe: a campaign that calls customers about upcoming or overdue payments, then automatically follows up by SMS when the call goes unanswered — one AI making the channel decision per contact.
- [Build a Voice Agent That Books Appointments Mid-Call](https://www.revve.ai/docs/guides/appointment-booking-voice-agent.md): A complete, copy-paste recipe: a Voice Agent that checks real calendar availability and books an appointment for the caller before the call ends — no callback, no separate booking step.
- [Build a Support Agent with Human Escalation](https://www.revve.ai/docs/guides/support-agent-with-escalation.md): A complete, copy-paste recipe for the support lead: a website agent that answers from your knowledge base, escalates the right conversations to your team, and files tickets for issues that need follow-up.
- [Build a Speed-to-Lead Callback Campaign](https://www.revve.ai/docs/guides/speed-to-lead-campaign.md): A complete, copy-paste recipe for the team wiring web forms or a CRM into Revve: one API call per new lead, and a voice agent calls them back within minutes, qualifies them, and books a meeting on your calendar.
- [What Is a Voice Agent?](https://www.revve.ai/docs/voice-agents/what-is-a-voice-agent.md): Learn what Voice Agents are, how they handle real phone calls, and when to use one instead of (or alongside) a Chat Agent.
- [Creating Your First Voice Agent](https://www.revve.ai/docs/voice-agents/creating-your-first-voice-agent.md): Create a Voice Agent from a template, test it with a live call from your browser, and publish it — step by step.
- [Voice Agent Settings](https://www.revve.ai/docs/voice-agents/voice-agent-settings.md): Every Voice Agent setting explained — what it does, its default, and when you should (and shouldn't) change it.
- [Voice Conversational Flow](https://www.revve.ai/docs/voice-agents/voice-conversational-flow.md): For voice agent builders: design multi-stage calls as a graph of nodes with explicit transitions instead of one system prompt.
- [Voice Agent Advanced Capabilities](https://www.revve.ai/docs/voice-agents/voice-agent-advanced-capabilities.md): The remaining Advanced Settings tabs — outbound caller ID, Vietnamese phone verification and normalization, retries, webhooks, call analysis, security, and notifications — for the agent builder taking a working agent to production.
- [Voice Agent Evaluation](https://www.revve.ai/docs/voice-agents/voice-agent-evaluation.md): Automatically score every completed call against a weighted set of metrics — deterministic checks and LLM-judged criteria — so you know an agent is performing before you find out from a customer complaint.
- [Voice Agent Tools](https://www.revve.ai/docs/voice-agents/voice-agent-tools.md): The preset Tools available in a Voice Agent's Advanced Settings — what each one does, and which ones silently don't work on a phone call.
- [Transferring Calls to a Human](https://www.revve.ai/docs/voice-agents/call-transfer.md): Configure a voice agent to hand a live call to a human — in-app to a Revve user, or out to a SIP address or phone number.
- [Do Not Call List](https://www.revve.ai/docs/voice-agents/do-not-call-list.md): A team-wide list of phone numbers your Voice Agents will never call — checked automatically before every outbound call, and populated automatically when a call's analysis flags a do-not-call request.
- [Voice Agent Publishing & Versioning](https://www.revve.ai/docs/voice-agents/voice-agent-versioning.md): How drafts, publishing, and version history work for voice agents, and how they differ from chat agents.
- [What Is a Chat Agent?](https://www.revve.ai/docs/getting-started/what-is-a-chat-agent.md): Learn what Chat Agents are, which channels they support, and what they can do for your business.
- [Creating Your First Chat Agent](https://www.revve.ai/docs/getting-started/creating-your-first-chat-agent.md): Step-by-step guide to create, configure, and publish your first Chat Agent.
- [Understanding Engine Types](https://www.revve.ai/docs/getting-started/understanding-engine-types.md): Compare Single Prompt and Conversational Flow to choose the right engine for your agent.
- [Configuring Agent Identity](https://www.revve.ai/docs/general-configuration/configuring-agent-identity.md): Set your Chat Agent's name, description, and role to define how it presents itself to visitors.
- [Choosing an LLM Model](https://www.revve.ai/docs/general-configuration/choosing-an-llm-model.md): Select the model that powers your Chat Agent's responses — and find the other places in Revve where a model choice matters.
- [Welcome Messages and Conversation Starters](https://www.revve.ai/docs/general-configuration/welcome-messages-and-conversation-starters.md): Configure what visitors see when they first open your chat widget.
- [Language and Tone Settings](https://www.revve.ai/docs/general-configuration/language-and-tone-settings.md): Configure which languages your agent supports and what communication style it uses.
- [Chat Agent Advanced Settings](https://www.revve.ai/docs/general-configuration/chat-agent-advanced-settings.md): Every panel on a chat agent's Advanced Settings tab — defaults, trade-offs, and when to change each one — for the builder tuning agent behavior beyond the prompt.
- [Flow Editor Overview](https://www.revve.ai/docs/conversational-flow/flow-editor-overview.md): An introduction to the visual Conversational Flow editor and how to access it.
- [Creating and Connecting Nodes](https://www.revve.ai/docs/conversational-flow/creating-and-connecting-nodes.md): How to add new nodes, define transitions between them, and set conditions that control the conversation path.
- [Global Nodes and Prompts](https://www.revve.ai/docs/conversational-flow/global-nodes-and-prompts.md): How to configure nodes that are accessible from any point in the conversation and set instructions that apply across all nodes.
- [Flow Node Features](https://www.revve.ai/docs/conversational-flow/flow-node-features.md): Per-node settings for contact collection, meeting scheduling, human escalation, testimonials, tools, and automation.
- [Knowledge Base Overview](https://www.revve.ai/docs/knowledge-base/knowledge-base-overview.md): Understand how your AI agent uses your content to deliver accurate, helpful answers.
- [Adding Web Pages and Documents](https://www.revve.ai/docs/knowledge-base/adding-web-pages-and-documents.md): Upload files, add web page URLs, and set up automated crawlers to keep your agent's knowledge current.
- [Managing FAQs](https://www.revve.ai/docs/knowledge-base/managing-faqs.md): Create and organize question-and-answer pairs to give your agent precise responses to common questions.
- [Knowledge Gaps](https://www.revve.ai/docs/knowledge-base/knowledge-gaps.md): Find questions your agent could not answer and fill the gaps in your knowledge base.
- [Knowledge Base Settings](https://www.revve.ai/docs/knowledge-base/knowledge-base-settings.md): Configure how your agent searches the knowledge base to find the best answers.
- [Channels Overview](https://www.revve.ai/docs/channel-setup/channels-overview.md): For workspace admins and agent builders deciding which messaging channels to connect and how to keep those connections healthy.
- [Website Widget Appearance and Styling](https://www.revve.ai/docs/channel-setup/website-appearance-and-styling.md): Customize the look and feel of your website chat widget, including colors, avatar, size, and advanced CSS overrides.
- [Website Installation](https://www.revve.ai/docs/channel-setup/website-installation.md): How to install the Revve AI chat widget on your website using JavaScript or WordPress.
- [Website Bubble Messages](https://www.revve.ai/docs/channel-setup/website-bubble-messages.md): Configure bubble messages, dynamic messages by URL, and conversation content settings for your website chat widget.
- [Email Channel Setup](https://www.revve.ai/docs/channel-setup/email-channel-setup.md): Connect email accounts and configure how your Chat Agent handles email conversations.
- [SMS Channel Setup](https://www.revve.ai/docs/channel-setup/sms-channel-setup.md): Connect a Twilio phone number to enable your Chat Agent to communicate via SMS.
- [WhatsApp Channel Setup](https://www.revve.ai/docs/channel-setup/whatsapp-channel-setup.md): Connect your WhatsApp Business profile to enable your Chat Agent to communicate via WhatsApp.
- [Zalo Channel Setup](https://www.revve.ai/docs/channel-setup/zalo-channel-setup.md): Connect your Zalo Official Account to enable your Chat Agent to communicate via Zalo.
- [Messenger Channel Setup](https://www.revve.ai/docs/channel-setup/messenger-channel-setup.md): Connect your Facebook Page to enable your Chat Agent to communicate via Facebook Messenger.
- [TikTok Channel Setup](https://www.revve.ai/docs/channel-setup/tiktok-channel-setup.md): For workspace admins and agent builders: connect a TikTok Business account and put a chat agent on TikTok Direct Messages.
- [What Is a Campaign?](https://www.revve.ai/docs/campaigns/campaign-overview.md): Campaigns put an AI in charge of outbound engagement — it decides what to send each contact, when, and on which channel, until they reach your goal.
- [Creating a Campaign](https://www.revve.ai/docs/campaigns/creating-a-campaign.md): Step-by-step: create a campaign, configure agents and engagement flow, publish it, enroll contacts, and monitor results.
- [Campaign Versioning](https://www.revve.ai/docs/campaigns/campaign-versioning.md): How campaign drafts, publishing, and version history work, including the one campaign-specific twist: in-flight enrollments.
- [Automation Rules — Overview](https://www.revve.ai/docs/automations/automation-rules-overview.md): For team admins deciding what follow-up work to automate: what Automation Rules can react to, what they can do, and how executions behave.
- [Creating Automation Rules](https://www.revve.ai/docs/automations/creating-automation-rules.md): For builders wiring follow-up actions to events: create a rule, pick a trigger, add conditions and actions, test it, and activate.
- [What Is Evaluations?](https://www.revve.ai/docs/evaluations/evaluations-overview.md): Pre-ship regression testing for your agents — define scenarios, run them against a Text or Voice agent, and see pass/fail results and transcripts before real customers hit the change.
- [Creating an Evaluator](https://www.revve.ai/docs/evaluations/creating-an-evaluator.md): Define a test case, attach it to a Text or Voice agent, launch a Run, and read the pass/fail results — the full create-run-inspect loop for Evaluations.
- [Evaluation Profiles](https://www.revve.ai/docs/evaluations/evaluation-profiles.md): Reference for agent builders configuring the simulated caller in voice evaluations — every field in the New Profile dialog, plus how to write caller personas worth testing against.
- [Evaluation Metrics](https://www.revve.ai/docs/evaluations/evaluation-metrics.md): The team-wide library of reusable scoring criteria — deterministic checks and LLM-judged rubrics — shared by Evaluators, Scorecards, and the per-Voice-Agent Evaluation tab.
- [Scorecards](https://www.revve.ai/docs/evaluations/scorecards.md): Reusable weighted-metrics policies for batch-grading uploaded recordings of real calls — for the QA lead auditing compliance, sampling agent quality, or scoring calls made outside Revve.
- [Inbox Overview](https://www.revve.ai/docs/inbox/inbox-overview.md): Your central hub for managing all customer conversations in real time.
- [Managing Conversations](https://www.revve.ai/docs/inbox/managing-conversations.md): How to assign conversations, apply labels, change status, reply to visitors, and leave internal comments.
- [Filtering and Searching Conversations](https://www.revve.ai/docs/inbox/filtering-and-searching.md): How to find specific conversations using search, filters, and the filter panel.
- [Conversation Analysis Panel](https://www.revve.ai/docs/inbox/conversation-analysis-panel.md): Understanding the right-side panel that displays agent info, contact data, AI analysis, tickets, evaluation, and comments.
- [Human Takeover](https://www.revve.ai/docs/inbox/human-takeover.md): How to take over a conversation from the AI, hand it back, and track who is responding.
- [Working with Tickets](https://www.revve.ai/docs/tickets/working-with-tickets.md): For daily operators triaging and resolving tickets, and admins configuring ticket types — the ticket list, the detail sidebar, and the four ways tickets get created.
- [Managing Contacts](https://www.revve.ai/docs/contacts/managing-contacts.md): How team members who work customer records day to day use the Contacts page — searching the list, editing details in the contact panel, tracing engagement history, and modeling your own data with custom contact fields.
- [Chat History](https://www.revve.ai/docs/history-analytics/chat-history.md): Browse, filter, and review all past conversations across your Chat Agents.
- [Exporting Conversations](https://www.revve.ai/docs/history-analytics/exporting-conversations.md): Download your chat history as CSV files for offline analysis and reporting.
- [Analytics Dashboard](https://www.revve.ai/docs/history-analytics/analytics-dashboard.md): Four dashboards for operators and team leads: an auto-refreshing Overview, Chat Agents website engagement, AI Agents containment and quality, and Human Agents team performance.
- [Daily Reports](https://www.revve.ai/docs/history-analytics/daily-reports.md): Receive automated daily performance summaries for your Chat Agents by email.
- [Apps & Integrations Overview](https://www.revve.ai/docs/integrations/integrations-overview.md): For the admin connecting Revve to the rest of their stack — where integrations live, who can install them, and how installed apps power agent features.
- [Connecting Calendly](https://www.revve.ai/docs/integrations/connecting-calendly.md): For workspace admins: install the Calendly app via OAuth, set up scheduling profiles, and make your calendars available to chat and voice agents.
- [Scheduling & Booking with Agents](https://www.revve.ai/docs/integrations/scheduling-and-booking.md): For the builder wiring calendars into agents — which scheduling apps Revve supports, where the Calendar App selector appears in chat and voice agents, and how to set up Cal.com and ChiliPiper.
- [Roles & Permissions](https://www.revve.ai/docs/governance-access/roles-and-permissions.md): How team-level role-based access control works in Revve — default roles, the permission catalog, custom roles, and how members and invitations are managed.
- [Publish Approval Workflow](https://www.revve.ai/docs/governance-access/publish-approval-workflow.md): The maker-checker control behind publishing campaigns, voice agents, and chat agents — who can request a publish, who can approve or decline it, and how that's enforced.
- [Workspace Settings](https://www.revve.ai/docs/administration/workspace-settings.md): The team-wide settings reference for workspace admins — general defaults, brand context, calling guardrails, alerts, secrets, audit logs, and conversation timeouts.
- [Conversation Routing](https://www.revve.ai/docs/administration/conversation-routing.md): For the admin who decides which humans get which conversations: set up the routing pool, tune the preset rules, and add custom rules for specific customer segments.
- [Phone Numbers](https://www.revve.ai/docs/administration/phone-numbers.md): For workspace admins who manage the team's calling infrastructure — adding Twilio and SIP numbers, assigning inbound agents, enabling SMS, and rotating numbers before spam-labeling kills your connection rates.
- [Conversation Fields](https://www.revve.ai/docs/administration/conversation-fields.md): For the admin who designs how conversations are classified: build a hierarchical label taxonomy that operators tag in the Inbox, routing rules match on, and flow automations set for you.
- [Widget SDK Reference](https://www.revve.ai/docs/developers/widget-sdk-reference.md): JavaScript API reference for developers integrating the Revve chat widget: boot configuration, commands, events, visitor identity, and metadata.
- [Enroll a contact in a campaign](https://www.revve.ai/docs/api-reference/enroll-a-contact-in-a-campaign.md): Enrolls an existing Revve contact into a campaign. Use this when the contact already exists in Revve and you just need to start (or advance) their campaign journey. To create the contact and enroll it in one call, use `POST /api/campaigns/contact-enrollments` instead.
- [Create a contact and enroll it in a campaign](https://www.revve.ai/docs/api-reference/create-a-contact-and-enroll-it-in-a-campaign.md): Creates (or updates, if a matching contact already exists) a Revve contact from a phone number and enrolls it into a campaign in one call. Use this when the contact doesn't exist in Revve yet — for example, a lead arriving straight from your core system or CRM. If `campaignId` is omitted, this only…
- [Create a contact](https://www.revve.ai/docs/api-reference/create-a-contact.md): Creates a contact in your team. Any keys beyond the standard fields are stored as custom contact properties. If `campaignId` is provided, the new contact is also enrolled into that campaign on a best-effort basis — enrollment failures are logged but do not fail this request, so verify enrollment sep…
- [Trigger an outbound call](https://www.revve.ai/docs/api-reference/trigger-an-outbound-call.md): Places (or schedules) an outbound call from a voice agent to a phone number. The contact is created or updated from the identifying fields before dialing, so the agent's `{{contact}}` placeholders resolve. Any additional body fields beyond the ones listed become dynamic variables available to the ag…

## OpenAPI Specs

- [openapi](https://www.revve.ai/docs/api-reference/openapi.json)