# Chatvox Docs > The public documentation hub for Chatvox. ## Docs - [Chatvox Documentation](https://chatvox.co/docs): Learn how to build, train, and deploy AI agents with Chatvox, from your first agent to actions, human handoff, and billing. ## Getting Started - [Introduction to Chatvox](https://chatvox.co/docs/getting-started/introduction): What Chatvox is, how agents, knowledge, and deployments fit together, and where to go next in these docs. - [Quick Start](https://chatvox.co/docs/getting-started/quick-start): Go from sign-up to a live AI agent on your website in a few minutes. Create a team, train an agent, and publish it. - [Create Your First Agent](https://chatvox.co/docs/getting-started/create-your-first-agent): Walk through the agent setup flow step by step. Add knowledge, set the identity and appearance, then review before you publish. - [Add Knowledge](https://chatvox.co/docs/getting-started/add-knowledge): Teach your agent about your business by adding your website and other knowledge sources it can answer from. - [Test Your Agent](https://chatvox.co/docs/getting-started/test-your-agent): Use the Playground to chat with your agent, try different models and instructions, and check answers before you go live. - [Deploy Your Agent](https://chatvox.co/docs/getting-started/deploy-your-agent): Put your agent in front of customers with the web widget, a public chat page, or WhatsApp. - [Tips for Best Results](https://chatvox.co/docs/getting-started/tips-for-best-results): Practical tips to get accurate answers, a better customer experience, and more value from your agent and your credits. ## Agents - [Creating and managing agents](https://chatvox.co/docs/agents/creating-and-managing-agents): Create, open, and delete agents in your team, and find your way around an agent's pages. - [API connections](https://chatvox.co/docs/agents/api-connections): Save an API base URL, authentication, and headers once, then reuse them in Custom API actions and widget functions for the same agent. - [Agent Instructions](https://chatvox.co/docs/agents/instructions): Write instructions that shape how your agent behaves, what it focuses on, and how it responds to your customers. - [AI Models](https://chatvox.co/docs/agents/ai-models): Choose the AI model that powers your agent and understand how the model affects answer quality, speed, and credit usage. - [Playground](https://chatvox.co/docs/agents/playground): Chat with your agent in a test space, adjust its model and instructions, and reset conversations as you iterate. - [Agent Settings](https://chatvox.co/docs/agents/settings): Configure your agent's name and role, conversation history, credit limit, AI model, instructions, attachments, and training. - [Attachments and Voice Messages](https://chatvox.co/docs/agents/attachments): Let customers send images, PDFs, and voice messages to your agent on the web widget, Public Chat, and WhatsApp. - [Agent Security](https://chatvox.co/docs/agents/security): Protect your agent from abuse with a rate limit, and verify signed-in users with user identification. ## Knowledge - [Knowledge overview](https://chatvox.co/docs/knowledge): How knowledge sources work, how your agent uses them to answer questions, and which source types you can add. - [Websites and URLs](https://chatvox.co/docs/knowledge/websites-and-urls): Find pages across your website and choose which to add, or add one page directly. - [Sitemaps](https://chatvox.co/docs/knowledge/sitemaps): Import pages in bulk from your website's sitemap so your agent learns from your whole site in one step. - [File uploads](https://chatvox.co/docs/knowledge/file-uploads): Upload PDFs, Word documents, and text files so your agent can answer questions from their contents. - [Text](https://chatvox.co/docs/knowledge/text): Add knowledge by pasting text directly, for information that isn't on a web page or in a file. - [Questions and answers](https://chatvox.co/docs/knowledge/questions-and-answers): Give your agent exact answers to common questions so it responds accurately and consistently every time. - [Managing Knowledge Sources](https://chatvox.co/docs/knowledge/managing-sources): Review, search, retry, and delete the knowledge sources your agent learns from, and check their training status. - [Retraining Knowledge](https://chatvox.co/docs/knowledge/retraining): Keep your agent up to date by retraining its sources when your website or documents change, manually or automatically. ## Deployments - [Deployments Overview](https://chatvox.co/docs/deployments): The channels where your agent can talk to customers (web widget, public chat, and WhatsApp) and how to turn each one on or off. ### Web Widget - [Installation](https://chatvox.co/docs/deployments/web-widget/installation): Add the Chatvox chat widget to your website with a single script tag, on any platform that lets you edit your site's HTML. - [General settings](https://chatvox.co/docs/deployments/web-widget/general-settings): Configure the web widget's install script, avatar, and channel instructions from the General tab of the widget settings. - [Appearance](https://chatvox.co/docs/deployments/web-widget/appearance): Match the web widget to your brand with your colors, position on the page, launcher button, and typing indicator. - [Behavior](https://chatvox.co/docs/deployments/web-widget/behavior): Control how the web widget behaves: its welcome message, suggested prompts, custom open buttons, and which websites can embed it. - [User identification](https://chatvox.co/docs/deployments/web-widget/user-identification): Tell the web widget who your signed-in users are with a signed token, so your agent and your team know who they're talking to. ### Public Chat - [General settings](https://chatvox.co/docs/deployments/public-chat/general-settings): Share your agent on a hosted chat page with its own link. No website or code required. - [Appearance](https://chatvox.co/docs/deployments/public-chat/appearance): Customize how your public chat page looks, including the logo, theme style, accent color, and typing indicator. - [Behavior](https://chatvox.co/docs/deployments/public-chat/behavior): Customize the content of your public chat page: the hero title and subtitle, first response, suggested prompts, and sidebar links. ### WhatsApp - [Connecting WhatsApp](https://chatvox.co/docs/deployments/whatsapp/connecting-whatsapp): Connect a WhatsApp Business number to your agent through Meta, so customers can chat with your agent on WhatsApp. - [Configuration](https://chatvox.co/docs/deployments/whatsapp/configuration): Configure how your agent behaves on WhatsApp once your number is connected, including WhatsApp-only instructions. - [Message templates](https://chatvox.co/docs/deployments/whatsapp/message-templates): Sync approved WhatsApp message templates from Meta so your team can message customers after the 24-hour window ends. ## Actions - [Actions overview](https://chatvox.co/docs/actions): Give your agent abilities beyond answering questions, such as collecting leads, searching the web, notifying your team, or calling your own API or MCP server. - [Configuring Actions](https://chatvox.co/docs/actions/configuring-actions): Create, customize, enable, disable, and delete actions on an agent, and choose which channels each action runs on. - [Trigger conditions](https://chatvox.co/docs/actions/trigger-conditions): Decide when your agent should run an action by describing what the visitor is asking for or trying to do. - [Action Steps](https://chatvox.co/docs/actions/action-steps): In the Playground and Logs, see the sources and actions behind each reply: what ran, what it sent and received, and why other actions didn't run. - [Collect Leads](https://chatvox.co/docs/actions/collect-leads): Have your agent ask for contact details during a conversation and save them as leads, with your own custom fields. - [Web Search](https://chatvox.co/docs/actions/web-search): Let your agent search the web in real time for information that isn't in its knowledge sources. - [Escalate to Human](https://chatvox.co/docs/actions/escalate-to-human): Hand a conversation from your agent to your team through live chat or a Helpdesk ticket, when a visitor asks or when your conditions are met. - [Slack Notifications](https://chatvox.co/docs/actions/slack-notifications): Send a message to a Slack channel when something important happens in a conversation, such as a new lead or an urgent issue. - [Custom API](https://chatvox.co/docs/actions/custom-api): Configure a Custom API action to call an API connection, use the response in a conversation, and optionally show an interactive widget. - [MCP Server](https://chatvox.co/docs/actions/mcp-server): Connect an MCP server so your agent can use its tools during a conversation, such as looking up orders or booking appointments. ## Widgets - [Widgets](https://chatvox.co/docs/widgets): Build interactive cards that appear under your agent’s replies after an API action or when a widget condition matches. - [Build a widget](https://chatvox.co/docs/widgets/building-widgets): Create a widget with declared fields and example data, check its code, and show it from an API action or a matching widget condition. - [Component reference](https://chatvox.co/docs/widgets/components): Widgets use layout, text, media, and interactive components. Use this reference to choose components and their supported props. - [Functions and states](https://chatvox.co/docs/widgets/functions-and-states): Widget functions respond to visitor selections, and states control which sections appear. Reference function settings, placeholders, saved variables, and condition operators. - [Show products from your store](https://chatvox.co/docs/widgets/product-search-example): Build a product search widget with a WordPress demo API and a Custom API action. Show matching products with prices, stock badges, and links in the conversation. ## Leads and Contacts - [Leads and Contacts Overview](https://chatvox.co/docs/leads-and-contacts): The difference between leads and contacts in Chatvox, and how each one is created from your agent's conversations. - [Lead Capture](https://chatvox.co/docs/leads-and-contacts/lead-capture): How your agent collects contact details from visitors, what's saved with each lead, and how to get notified about new ones. - [Managing Leads](https://chatvox.co/docs/leads-and-contacts/managing-leads): Review, edit, export, and delete the leads your agent has collected. - [Campaign Tracking](https://chatvox.co/docs/leads-and-contacts/campaign-tracking): See which campaign brought each conversation and lead, using the UTM parameters in your links. No code needed. - [Managing Contacts](https://chatvox.co/docs/leads-and-contacts/managing-contacts): View the customers your agent recognizes, with their profile, identities, conversations, and captured leads. - [Customer Identification](https://chatvox.co/docs/leads-and-contacts/customer-identification): How Chatvox recognizes returning customers on the web widget, Public Chat, and WhatsApp, and links their conversations to a contact. ## Human Handoff - [Human Handoff Overview](https://chatvox.co/docs/human-handoff): Let your team step into a conversation when a customer needs a person, through live chat or Helpdesk tickets. - [Configuring Human Handoff](https://chatvox.co/docs/human-handoff/configuring): Turn on human handoff for an agent with the Escalate to Human action, and choose how and when conversations reach your team. - [Live Support](https://chatvox.co/docs/human-handoff/live-support): Reply to customers in real time from the Helpdesk after a conversation is handed off from your agent. - [Tickets](https://chatvox.co/docs/human-handoff/tickets): Track handed-off conversations as Helpdesk tickets: statuses, assignees, internal notes, visitor emails, and how to resolve them. - [Managing Conversations](https://chatvox.co/docs/human-handoff/managing-conversations): Review, filter, export, and delete your agent's conversations from the Logs page. ## Integrations - [Integrations Overview](https://chatvox.co/docs/integrations): Connect Chatvox to other tools your team uses, so your agent's actions can work with them. ### Slack - [Connecting Slack](https://chatvox.co/docs/integrations/slack/connecting-slack): Connect your Slack workspace to a Chatvox agent so it can post notifications to your channels. - [Configuring Notifications](https://chatvox.co/docs/integrations/slack/configuring-notifications): Choose which Slack channel receives notifications from your agent, and the situations that should send one. - [Troubleshooting](https://chatvox.co/docs/integrations/slack/troubleshooting): Fix common problems with the Slack integration, such as missing channels, notifications that don't arrive, or a lost connection. ### Salesforce - [Connecting Salesforce](https://chatvox.co/docs/integrations/salesforce/connecting-salesforce): Connect an agent to your Salesforce org with your own External Client App, so it can send leads, log conversations, and create support cases. - [Add Leads to Salesforce](https://chatvox.co/docs/integrations/salesforce/add-leads): Send the leads your agent collects to Salesforce automatically, and optionally log each conversation to the lead's activity. - [Create Tickets in Salesforce](https://chatvox.co/docs/integrations/salesforce/create-tickets): Let your agent open a Salesforce case when a customer needs follow-up from your support team, and give them the case number. ## Analytics - [Analytics Overview](https://chatvox.co/docs/analytics): Where to see how your agents are performing, what customers think of their answers, and how many credits your team is using. - [Agent Analytics](https://chatvox.co/docs/analytics/agent-analytics): Track conversations, messages, and customer feedback for each agent over a date range you choose. - [Conversations](https://chatvox.co/docs/analytics/conversations): Review your agent's past conversations and customer feedback to find gaps in its knowledge and improve its answers. - [Usage Analytics](https://chatvox.co/docs/analytics/usage-analytics): See how many credits your team has used this billing cycle, and how much each agent is using. ## Billing - [Plans and Pricing](https://chatvox.co/docs/billing/plans-and-pricing): Compare the Free, Starter, Standard, and Pro plans, including monthly credits, agents, team members, knowledge, Actions & Widgets, and features. - [Understanding Credits](https://chatvox.co/docs/billing/understanding-credits): How credits work, what uses them, and the order in which your monthly and purchased credits are spent. - [Usage and Limits](https://chatvox.co/docs/billing/usage-and-limits): Check your plan limits for agents, team members, knowledge storage, and Actions & Widgets, and see what happens when you reach them. - [Managing Subscriptions](https://chatvox.co/docs/billing/managing-subscriptions): Upgrade, downgrade, or cancel your team's plan, manage add-ons, and update payment details and invoices. - [Additional Credits](https://chatvox.co/docs/billing/additional-credits): Buy extra credits with a one-time credit pack when your team needs more than the monthly credits included in its plan. ## Account and Teams - [Account Settings](https://chatvox.co/docs/account-and-teams/account-settings): Update your profile, email address, password, and appearance preferences. - [Team Management](https://chatvox.co/docs/account-and-teams/team-management): Create teams, switch between them, update your team's name and icon, and leave or delete a team. - [Team Members](https://chatvox.co/docs/account-and-teams/team-members): Invite people to your team, choose their role, manage pending invitations, and remove members. - [Roles and Permissions](https://chatvox.co/docs/account-and-teams/roles-and-permissions): What Owners, Admins, Editors, and Viewers can do in a Chatvox team. - [Two-factor authentication](https://chatvox.co/docs/account-and-teams/two-factor-authentication): Protect your Chatvox account with a second sign-in step using an authenticator app on your phone. ## Developers - [Developer Overview](https://chatvox.co/docs/developers): Connect Chatvox to your own systems with the REST API and webhooks: chat with agents, read leads and conversations, manage knowledge, and get notified of events. - [API Keys](https://chatvox.co/docs/developers/api-keys): Create, scope, and revoke Chatvox API keys, and keep them secure. - [Errors and Rate Limits](https://chatvox.co/docs/developers/errors-and-rate-limits): Chatvox API status codes, error responses, and request limits. - [Agents and Chat](https://chatvox.co/docs/developers/agents-and-chat): List your agents and chat with them through the Chatvox API, including continuing conversations and linking them to your own users. - [Conversations](https://chatvox.co/docs/developers/conversations): Read an agent's conversations and messages through the Chatvox API. - [Leads](https://chatvox.co/docs/developers/leads): Read the leads your agents collect through the Chatvox API. - [Knowledge Sources](https://chatvox.co/docs/developers/knowledge-sources): Add, check, and delete an agent's knowledge through the Chatvox API: text, Q&A, web pages, sitemaps, and files. - [Webhooks](https://chatvox.co/docs/developers/webhooks): Get a signed request from Chatvox when a lead is captured, a visitor asks for a person, or a Helpdesk ticket is opened. - [Verifying Webhooks](https://chatvox.co/docs/developers/verifying-webhooks): Check that webhook requests really come from Chatvox using the signing secret, with examples for Node.js, PHP, and Python. - [Zapier, Make, and n8n](https://chatvox.co/docs/developers/zapier-make-n8n): Connect Chatvox to thousands of apps without code using Zapier, Make, or n8n, with webhooks for events and API calls to chat with agents. ## Troubleshooting - [Troubleshooting](https://chatvox.co/docs/troubleshooting): Fix common problems with human handoff, tickets, visitor emails, attachments, and integrations. - [Human Handoff and Tickets](https://chatvox.co/docs/troubleshooting/human-handoff-and-tickets): Fix common problems with live chat handoff, Helpdesk tickets, email verification, visitor emails, and Continue the conversation links. - [Attachments and Voice Messages](https://chatvox.co/docs/troubleshooting/attachments-and-voice-messages): Fix common problems when customers send images, PDFs, or voice messages to your agent. ## Agent skills - [chatvox-docs](https://chatvox.co/docs/.well-known/agent-skills/chatvox-docs/SKILL.md): Read the Chatvox Docs instead of answering from memory. The public documentation hub for Chatvox. Use when a task involves Chatvox Docs: how it works, how to set it up or configure it, or its API. ## Agent resources - [llms-full.txt](https://chatvox.co/docs/llms-full.txt): The full Markdown of every page in one file. - [Page Markdown](https://chatvox.co/docs/index.md): Append `.md` to any page URL to fetch that page as raw Markdown. - [JSON API](https://chatvox.co/docs/api/docs/pages.json): Page index of the JSON docs API; each entry links the page's JSON and Markdown forms. Described by the OpenAPI document at https://chatvox.co/docs/openapi.json. - [Agent skills](https://chatvox.co/docs/.well-known/agent-skills/index.json): Agent Skills discovery index of the skills this site publishes. - [API catalog](https://chatvox.co/docs/.well-known/api-catalog): RFC 9727 linkset of the APIs documented here. - [AI catalog](https://chatvox.co/docs/.well-known/ai-catalog.json): ARD manifest of the agent-facing resources on this site (MCP server, skills, APIs). - [agent-readability.json](https://chatvox.co/docs/agent-readability.json): Manifest of every agent-facing artifact on this site. - [Sitemap](https://chatvox.co/docs/sitemap.xml): Every indexable page URL with its last-modified date.