# Chatbase

- [Welcome to Chatbase](https://chatbase.co/docs/user-guides/quick-start/introduction.md): Get started with Chatbase and discover how to build intelligent agents trained on your business data.
- [Build Your First AI Agent](https://chatbase.co/docs/user-guides/quick-start/your-first-agent.md): Create, train, and deploy your first AI Agent in under 5 minutes. Follow this step-by-step guide to get your intelligent assistant live on your website.
- [Best Practices](https://chatbase.co/docs/user-guides/quick-start/best-practices.md): This page offers tips to help you improve your AI agent's performance and user experience. It covers improving the instructions, teaching the agent how to send links.
- [Backstage](https://chatbase.co/docs/user-guides/chatbot/backstage.md): Backstage is an AI-powered operations center that lets users manage their AI agent through natural language conversation, instead of navigating multiple settings pages manually. Think of it as a copilot for AI agent management — users describe what they want in plain English, and Backstage handles t…
- [Playground](https://chatbase.co/docs/user-guides/chatbot/playground.md): Preview your agent across supported channels and customize its style and capabilities in real time.
- [Build](https://chatbase.co/docs/user-guides/chatbot/build.md): Configure everything your agent needs to operate, including its instructions, knowledge, actions, widgets, and channel-specific behavior.
- [Data sources](https://chatbase.co/docs/user-guides/chatbot/data-sources.md): Add files, websites, text, Q&A, Notion pages, and support tickets to train your AI agent, and keep them in sync.
- [Channels](https://chatbase.co/docs/user-guides/chatbot/channels.md): Build your Chatbase agent across web, messaging, phone, and productivity channels.
- [Overview](https://chatbase.co/docs/user-guides/chatbot/actions/actions-overview.md): Actions let your AI agent do more than answer questions — trigger a task, pull in data, or hand off to a person
- [Escalations](https://chatbase.co/docs/user-guides/chatbot/actions/escalate-to-human.md): Let your AI agent hand a conversation to a human by creating a ticket in Chatbase Helpdesk or your connected helpdesk platform
- [Chatbase Live Chat](https://chatbase.co/docs/user-guides/chatbot/actions/chatbase-live-chat.md): Hand a conversation from your AI agent to a human agent in the Chatbase Help Desk, in real time
- [Custom Action](https://chatbase.co/docs/user-guides/chatbot/actions/custom-action.md): Call your own API, run code in the browser, or show an interactive widget, all from inside the conversation
- [Stripe Actions](https://chatbase.co/docs/user-guides/chatbot/actions/stripe-action.md): Let customers check their subscription, review invoices, change plans, and update billing details from the chat
- [Custom Button](https://chatbase.co/docs/user-guides/chatbot/actions/custom-button.md): Send customers a clickable button that links to any page you choose, right inside the conversation
- [Collect Leads](https://chatbase.co/docs/user-guides/chatbot/actions/collect-leads.md): Capture a visitor's contact details as a lead, either through a form in the chat or conversationally
- [Collect Data](https://chatbase.co/docs/user-guides/chatbot/actions/collect-data.md): Have your AI agent gather any custom fields you define from the customer, conversationally, mid-chat
- [Suggested Messages](https://chatbase.co/docs/user-guides/chatbot/actions/suggested-messages.md): Display clickable reply suggestions to help customers navigate conversations more efficiently
- [Web Search](https://chatbase.co/docs/user-guides/chatbot/actions/web-search.md): Give your AI agent real-time web search so it can answer questions your training sources don't cover
- [Cal.com](https://chatbase.co/docs/user-guides/chatbot/actions/cal.md): Let customers check your availability and book meetings on your Cal.com calendar without leaving the chat
- [Calendly](https://chatbase.co/docs/user-guides/chatbot/actions/calendly.md): Let customers check your availability and book meetings on your Calendly calendar without leaving the chat
- [Slack](https://chatbase.co/docs/user-guides/chatbot/actions/slack.md): Notify a Slack channel whenever a conversation touches a topic your team needs to know about
- [Salesforce Actions](https://chatbase.co/docs/user-guides/chatbot/actions/salesforce-actions.md): Create support cases and connect customers to live agents in Salesforce when your AI agent needs to escalate
- [Shopify Actions](https://chatbase.co/docs/user-guides/chatbot/actions/shopify-actions.md): Help customers browse products, manage their cart, place and exchange orders, track deliveries, and update their account through your AI agent
- [WhatsApp Catalog](https://chatbase.co/docs/user-guides/chatbot/actions/whatsapp-catalog.md): Show your Shopify products as native WhatsApp product cards with cart support
- [Transfer to phone number](https://chatbase.co/docs/user-guides/chatbot/actions/transfer-to-phone.md): Transfer a live voice call from your AI Agent to a human by forwarding the caller to a phone number
- [Overview](https://chatbase.co/docs/user-guides/chatbot/procedures/procedures-overview.md): Give your AI agent a multi-step procedure (workflow) end to end to follow whenever a conversation matches a trigger you define.
- [How Procedures Run](https://chatbase.co/docs/user-guides/chatbot/procedures/how-procedures-run.md): How the AI agent decides which procedure to run, why a procedure may be skipped, and how procedure-only actions keep certain tools on rails.
- [Guardrails](https://chatbase.co/docs/user-guides/chatbot/guardrails.md): Protect your agent from abuse with rate limits, automatic spam detection, and country blocking.
- [Contacts Overview](https://chatbase.co/docs/user-guides/chatbot/contacts/contacts-overview.md): Learn how to use contacts to enable personalized, secure interactions between your users and AI agents.
- [Uploading Contacts](https://chatbase.co/docs/user-guides/chatbot/contacts/uploading-contacts.md)
- [Settings](https://chatbase.co/docs/user-guides/chatbot/settings.md)
- [Email settings](https://chatbase.co/docs/user-guides/chatbot/email-settings.md): Use your AI agent over email with agent emails, forwarding rules, and authenticated domains.
- [Activity](https://chatbase.co/docs/user-guides/chatbot/activity.md): This section shows the chat logs of the conversations your users had with your AI agent and the Lead forms filled by your users.
- [Analytics](https://chatbase.co/docs/user-guides/chatbot/analytics.md)
- [Outbound Campaigns](https://chatbase.co/docs/user-guides/chatbot/outbound-campaigns.md): Send targeted messages to your contacts at scale. Create campaigns, personalize content, and track delivery in real time.
- [WhatsApp Campaigns](https://chatbase.co/docs/user-guides/chatbot/outbound-whatsapp.md): Send outbound WhatsApp campaigns to your contacts using pre-approved Meta message templates. Step-by-step guide for creating, sending, and tracking WhatsApp campaigns.
- [Manage  ](https://chatbase.co/docs/user-guides/workspace/manage.md): Organize your users in Chatbase workspaces for better collaboration and permission control.
- [Usage](https://chatbase.co/docs/user-guides/workspace/usage.md): This tab displays the usage details of all AI agents in the selected workspace. You can also filter usage data for a specific workspace.
- [Workspace settings](https://chatbase.co/docs/user-guides/workspace/settings.md): Manage your workspace: details, members, plan, billing, API keys, and audit logs.
- [Two-factor authentication (2FA)](https://chatbase.co/docs/user-guides/workspace/two-factor-auth.md): Secure your Chatbase workspace with two-factor authentication and backup recovery codes.
- [HIPAA compliance](https://chatbase.co/docs/user-guides/workspace/hipaa-compliance.md): How Chatbase supports HIPAA-eligible workloads on Enterprise plans through a Business Associate Agreement and Zero Data Retention.
- [Webflow](https://chatbase.co/docs/user-guides/integrations/webflow.md)
- [WordPress](https://chatbase.co/docs/user-guides/integrations/wordpress.md)
- [Wix](https://chatbase.co/docs/user-guides/integrations/wix.md)
- [Weebly](https://chatbase.co/docs/user-guides/integrations/weebly.md)
- [Framer](https://chatbase.co/docs/user-guides/integrations/framer.md)
- [Bubble](https://chatbase.co/docs/user-guides/integrations/bubble.md)
- [Vercel](https://chatbase.co/docs/user-guides/integrations/vercel.md): Install Chatbase AI Agent directly from the Vercel Marketplace with one-click integration
- [WhatsApp](https://chatbase.co/docs/user-guides/integrations/whatsapp.md)
- [WhatsApp Templates](https://chatbase.co/docs/user-guides/integrations/whatsapp-templates.md): Learn how to create WhatsApp message templates in WhatsApp Manager and send them to customers from the Chatbase Helpdesk.
- [Messenger](https://chatbase.co/docs/user-guides/integrations/messenger.md)
- [Instagram](https://chatbase.co/docs/user-guides/integrations/instagram.md)
- [Twilio (Phone)](https://chatbase.co/docs/user-guides/integrations/twilio.md)
- [SIP Trunk (Phone)](https://chatbase.co/docs/user-guides/integrations/sip-trunk.md)
- [Slack](https://chatbase.co/docs/user-guides/integrations/slack.md)
- [Shopify](https://chatbase.co/docs/user-guides/integrations/shopify.md)
- [Stripe](https://chatbase.co/docs/user-guides/integrations/stripe.md)
- [Zendesk](https://chatbase.co/docs/user-guides/integrations/zendesk.md)
- [Freshdesk](https://chatbase.co/docs/user-guides/integrations/freshdesk.md)
- [Gorgias](https://chatbase.co/docs/user-guides/integrations/gorgias.md)
- [Zoho Desk](https://chatbase.co/docs/user-guides/integrations/zohodesk.md)
- [Intercom](https://chatbase.co/docs/user-guides/integrations/intercom.md)
- [HubSpot](https://chatbase.co/docs/user-guides/integrations/hubspot.md): Connect HubSpot to Chatbase so your AI agent can create tickets.
- [Salesforce](https://chatbase.co/docs/user-guides/integrations/salesforce.md)
- [Help Scout](https://chatbase.co/docs/user-guides/integrations/helpscout.md)
- [Odoo](https://chatbase.co/docs/user-guides/integrations/odoo.md)
- [Email](https://chatbase.co/docs/user-guides/integrations/email.md): Enable AI-powered email responses with automated customer support through email
- [Sunshine](https://chatbase.co/docs/user-guides/integrations/sunshine.md)
- [Zapier](https://chatbase.co/docs/user-guides/integrations/zapier.md)
- [ViaSocket](https://chatbase.co/docs/user-guides/integrations/viasocket.md)
- [Response Quality](https://chatbase.co/docs/user-guides/quick-start/response-quality.md): On this page, discover tips to improve your response quality. Learn how to refine prompts, optimize AI agent settings, and analyze behavior to deliver clearer, more effective, and engaging interactions.
- [Models Comparison](https://chatbase.co/docs/user-guides/chatbot/models-comparison.md)
- [ Helpdesk Overview](https://chatbase.co/docs/user-guides/chatbot/help-desk/help-desk-overview.md): Manage customer support tickets from a centralized dashboard.
- [Filters](https://chatbase.co/docs/user-guides/chatbot/help-desk/filters.md): The full set of fields, operators, and values you can use to filter the help desk inbox.
- [Saved Views](https://chatbase.co/docs/user-guides/chatbot/help-desk/saved-views.md): Save reusable inbox configurations so each agent sees the tickets that matter to them.
- [Priority](https://chatbase.co/docs/user-guides/chatbot/help-desk/priority.md): Rank tickets from Low to Urgent, then sort and filter the inbox so the most pressing work sits at the top.
- [Tags](https://chatbase.co/docs/user-guides/chatbot/help-desk/tags.md): Label tickets with your own keywords, then filter the inbox and build saved views around them.
- [Email Settings](https://chatbase.co/docs/user-guides/chatbot/help-desk/email-settings.md): Configure email addresses, display names, signatures, and previews for your Helpdesk.
- [Teams](https://chatbase.co/docs/user-guides/chatbot/help-desk/teams.md): Group your agents into teams so tickets can be routed and assigned to the right people.
- [Ticket Assignment](https://chatbase.co/docs/user-guides/chatbot/help-desk/assignment-algorithm.md): Automatically assign incoming tickets to the most available teammate, or let your team manually pick up work.
- [Scheduling](https://chatbase.co/docs/user-guides/chatbot/help-desk/scheduling.md): Define shifts and time off so agent availability and ticket auto-assignment run on their own.
- [Triggers](https://chatbase.co/docs/user-guides/chatbot/help-desk/triggers.md): Automate your help desk with ordered rules that run when tickets are created or updated, setting statuses, routing work, and adding notes for you.
- [Custom Fields](https://chatbase.co/docs/user-guides/chatbot/help-desk/custom-fields.md): Define the details your AI agent collects when it creates a ticket, and view or edit them on every ticket in the help desk.
- [Translation](https://chatbase.co/docs/user-guides/chatbot/help-desk/translation.md): Automatically detect and translate customer messages so your team can support anyone, in any language.
- [AI Draft Replies](https://chatbase.co/docs/user-guides/chatbot/help-desk/ai-draft-replies.md): Generate AI-powered draft responses for Helpdesk tickets and review them before sending.
- [Takeover](https://chatbase.co/docs/user-guides/chatbot/help-desk/takeover.md): Take over AI conversations and escalate them to help desk tickets for human support.
- [Team Routing](https://chatbase.co/docs/user-guides/chatbot/help-desk/team-routing.md): Automatically send incoming tickets to the right team using ordered, first-match rules.
- [Shopify Orders](https://chatbase.co/docs/user-guides/chatbot/help-desk/integrations/shopify.md): See a customer's Shopify order history right inside the ticket.
- [Chatbase Experts Program](https://chatbase.co/docs/user-guides/chatbase-experts/experts-program.md)
- [Developer Overview](https://chatbase.co/docs/developer-guides/overview.md): Welcome to the Chatbase Developer Guide! Whether you're embedding a simple chat widget or building complex integrations, this guide will help you implement AI-powered conversations in your application.
- [JavaScript Embed Script](https://chatbase.co/docs/developer-guides/javascript-embed.md): Complete guide to embedding Chatbase AI Agents in your web application with advanced customization options.
- [REST API Integration](https://chatbase.co/docs/developer-guides/api-integration.md): Complete guide to integrating Chatbase AI Agents using our REST API for custom integrations and applications.
- [Identity Verification](https://chatbase.co/docs/developer-guides/identity-verification.md): Authenticate users in your AI Agent widget just like they're authenticated on your website.
- [Client-Side Custom Actions](https://chatbase.co/docs/developer-guides/client-side-custom-actions.md): Execute custom actions directly in your user's browser with full control and seamless integration
- [Client-Side Custom Forms](https://chatbase.co/docs/developer-guides/client-side-custom-forms.md): Create dynamic, interactive forms in your agent using client-side JavaScript configuration
- [Chat bubble Control](https://chatbase.co/docs/developer-guides/chat-bubble-control.md): Programmatically control your chat bubble with JavaScript methods to open, close, reset conversations, and override configured options at runtime.
- [Event Listeners](https://chatbase.co/docs/developer-guides/chatbot-event-listeners.md): Listen for and respond to real-time chat events including user messages, AI responses, custom actions, and more to create interactive experiences.
- [Custom Initial Messages](https://chatbase.co/docs/developer-guides/custom-initial-messages.md): Create personalized welcome experiences by setting custom initial messages that greet users when your AI Agent first loads, with support for dynamic content and user personalization.
- [Floating Initial Messages](https://chatbase.co/docs/developer-guides/floating-initial-messages.md): Create eye-catching floating messages that appear above your chat widget to welcome visitors and boost engagement
- [Chat with a chatbot](https://chatbase.co/docs/api-reference/chat/chat-with-a-chatbot.md): Send a message to a chatbot and receive a response. Supports streaming responses. Can continue existing conversations by providing a conversationId.
- [Create a new chatbot](https://chatbase.co/docs/api-reference/chatbots/create-a-new-chatbot.md): Creates a new chatbot with training data from text
- [Get all chatbots](https://chatbase.co/docs/api-reference/chatbots/get-all-chatbots.md): Retrieves all chatbots for the authenticated account
- [Delete a chatbot](https://chatbase.co/docs/api-reference/chatbots/delete-a-chatbot.md): Permanently deletes a chatbot and all associated data
- [Update a chatbot](https://chatbase.co/docs/api-reference/chatbots/update-a-chatbot.md): Updates and retrains a chatbot with new content
- [Update chatbot settings](https://chatbase.co/docs/api-reference/chatbots/update-chatbot-settings.md): Updates various chatbot configuration settings
- [Get conversations for a chatbot](https://chatbase.co/docs/api-reference/conversations/get-conversations-for-a-chatbot.md): Retrieves conversation history for a specific chatbot
- [Get leads for a chatbot](https://chatbase.co/docs/api-reference/leads/get-leads-for-a-chatbot.md): Retrieves collected leads/customers for a specific chatbot
- [Upload chatbot icon](https://chatbase.co/docs/api-reference/assets/upload-chatbot-icon.md): Uploads an icon image for the chatbot
- [Upload chatbot profile picture](https://chatbase.co/docs/api-reference/assets/upload-chatbot-profile-picture.md): Uploads a profile picture for the chatbot
- [Delete chatbot icon](https://chatbase.co/docs/api-reference/assets/delete-chatbot-icon.md): Deletes the chatbot's icon image
- [Delete chatbot profile picture](https://chatbase.co/docs/api-reference/assets/delete-chatbot-profile-picture.md): Deletes the chatbot's profile picture
- [Get contacts for a chatbot](https://chatbase.co/docs/api-reference/contacts/get-contacts-for-a-chatbot.md): Retrieves paginated list of contacts for a specific chatbot
- [Create contacts for a chatbot](https://chatbase.co/docs/api-reference/contacts/create-contacts-for-a-chatbot.md): Creates one or more contacts for a specific chatbot (max 1000 per request)
- [Get a specific contact](https://chatbase.co/docs/api-reference/contacts/get-a-specific-contact.md): Retrieves a single contact by ID
- [Delete a contact](https://chatbase.co/docs/api-reference/contacts/delete-a-contact.md): Permanently deletes a contact
- [Update a contact](https://chatbase.co/docs/api-reference/contacts/update-a-contact.md): Updates an existing contact's information
- [Get custom attributes schema](https://chatbase.co/docs/api-reference/contacts/get-custom-attributes-schema.md): Retrieves the custom attributes schema for contacts
- [Create custom attribute](https://chatbase.co/docs/api-reference/contacts/create-custom-attribute.md): Creates a new custom attribute for contacts
- [Update custom attribute](https://chatbase.co/docs/api-reference/contacts/update-custom-attribute.md): Updates an existing custom attribute
- [Help Page Proxy](https://chatbase.co/docs/developer-guides/help-page-proxy.md)
- [Custom Domains](https://chatbase.co/docs/developer-guides/custom-domains.md): On this page, you can configure your AI agent to integrate with your own domain. This allows you to hide the Chatbase branding, making it appear as if the AI agent is built entirely by your workspace rather than using a third-party tool.
- [Webhook API Guide](https://chatbase.co/docs/developer-guides/webhooks.md): Guide to setting up webhooks to receive real-time notifications for when users submit your custom forms and events like phone call summaries.
- [HIPAA Conversation Webhook](https://chatbase.co/docs/developer-guides/hipaa-webhooks.md): Receive HIPAA conversations at your own endpoint before Chatbase deletes them under the retention window.
- [Widgets Overview](https://chatbase.co/docs/developer-guides/widgets/overview.md): Build interactive UI components that your AI agent can display inline during conversations — forms, cards, tables, charts, and more.
- [AI Widget Builder](https://chatbase.co/docs/developer-guides/widgets/ai-widget-builder.md): Generate widgets from natural language descriptions or pre-built templates using the AI builder.
- [Code Editor](https://chatbase.co/docs/developer-guides/widgets/code-editor.md): Write widget code, define schemas, and preview with examples using the code editor.
- [Functions](https://chatbase.co/docs/developer-guides/widgets/functions.md): Configure what happens when users interact with widget elements — API calls, messages, navigation, and data updates.
- [States](https://chatbase.co/docs/developer-guides/widgets/states.md): Conditionally show or hide parts of your widget based on data values using states and conditions.
- [Layout](https://chatbase.co/docs/developer-guides/widgets/components/layout.md): Layout components for structuring widget content — Card, Box, Col, Row, Spacer, Divider, ListView, and ListViewItem.
- [Text](https://chatbase.co/docs/developer-guides/widgets/components/text.md): Text components for displaying content — Text, Title, Caption, Label, and Markdown.
- [Media & Visual](https://chatbase.co/docs/developer-guides/widgets/components/media.md): Visual components for icons, images, badges, and animations.
- [Form Inputs](https://chatbase.co/docs/developer-guides/widgets/components/form-inputs.md): Form and input components for collecting user data — Form, Input, Textarea, Select, DatePicker, Checkbox, RadioGroup, and Slider.
- [Data Display](https://chatbase.co/docs/developer-guides/widgets/components/data-display.md): Components for displaying structured data — Table and Chart.
- [Interactive](https://chatbase.co/docs/developer-guides/widgets/components/interactive.md): Interactive components for user actions — Button.
- [API v2 Overview](https://chatbase.co/docs/api-v2/overview.md): Introduction to the Chatbase API v2 — a structured, modern REST API for chatting with agents and managing conversations.
- [Authentication](https://chatbase.co/docs/api-v2/authentication.md): How to authenticate with the Chatbase API v2 using Bearer tokens, and understand rate limiting.
- [Streaming](https://chatbase.co/docs/api-v2/streaming.md): How to use Server-Sent Events (SSE) streaming with the Chatbase API v2 for real-time responses.
- [Voice Sessions](https://chatbase.co/docs/api-v2/voice.md): Embed real-time voice conversations with your agent in your own app using the Voice Sessions API and the Chatbase Voice SDK.
- [Client Actions](https://chatbase.co/docs/api-v2/client-actions.md): Handle client-side actions invoked by your AI agent through the Chatbase API v2.
- [Error Handling](https://chatbase.co/docs/api-v2/error-handling.md): Structured error codes and troubleshooting guide for the Chatbase API v2.
- [Pagination](https://chatbase.co/docs/api-v2/pagination.md): How cursor-based pagination works in the Chatbase API v2.
- [Agents](https://chatbase.co/docs/api-v2/agents.md): Programmatically create, configure, and manage your Chatbase AI agents.
- [User Conversations](https://chatbase.co/docs/api-v2/user-conversations.md): Associate users with conversations, manage per-user history, and export full conversation data across all sources.
- [Sources](https://chatbase.co/docs/api-v2/sources.md): Programmatically manage the knowledge sources that power your Chatbase agent — web pages, documents, Q&A pairs, and text.
- [Helpdesk](https://chatbase.co/docs/api-v2/helpdesk.md): Programmatically create, triage, and reply to support tickets for your Chatbase agents.
- [WhatsApp](https://chatbase.co/docs/api-v2/whatsapp.md): List the approved WhatsApp templates available to your agent and send them to any phone number.
- [Health check](https://chatbase.co/docs/api-v2/health/health-check.md): Returns the API health status. No authentication required.
- [List agents](https://chatbase.co/docs/api-v2/agents/list-agents.md): Returns a paginated list of all agents for the authenticated account.
- [Create agent](https://chatbase.co/docs/api-v2/agents/create-agent.md): Creates a new agent. If `url` is provided, a link source is created from that URL and training is queued automatically.
- [Get agent](https://chatbase.co/docs/api-v2/agents/get-agent.md): Returns a single agent by ID.
- [Update agent](https://chatbase.co/docs/api-v2/agents/update-agent.md): Partially updates an agent. Only provided fields are changed.
- [Delete agent](https://chatbase.co/docs/api-v2/agents/delete-agent.md): Permanently deletes an agent and all its sources. Also disconnects any active integrations (Slack, WhatsApp, etc.). This action is irreversible.
- [Update agent styles](https://chatbase.co/docs/api-v2/agents/update-agent-styles.md): Updates the visual styles for an agent.
- [Toggle auto-retrain](https://chatbase.co/docs/api-v2/agents/toggle-auto-retrain.md): Enables or disables automatic retraining. When enabled, the agent retrains every 7 days to reflect any source changes.
- [Clone agent](https://chatbase.co/docs/api-v2/agents/clone-agent.md): Creates a full deep-clone of an agent, including all its sources (excluding Notion). Returns the new agent ID.
- [Train agent (deprecated)](https://chatbase.co/docs/api-v2/agents/train-agent-deprecated.md): **Deprecated.** Sources train as soon as they are created, updated or deleted, so changes take effect immediately and there is nothing to trigger. The call does nothing and always succeeds. Poll `GET /agents/{agentId}/sources/{sourceId}` and read `status` to follow a source, or `GET /agents/{agentId…
- [Chat with an agent](https://chatbase.co/docs/api-v2/agents/chat-with-an-agent.md): Send a message to an agent and receive a response. Supports streaming responses when `stream: true` is set in the request body.
- [Retry a message](https://chatbase.co/docs/api-v2/agents/retry-a-message.md): Retry generating an assistant response for a given message. Truncates the conversation at the target message, then re-sends the preceding user message through the chat service.
- [Start a voice session](https://chatbase.co/docs/api-v2/agents/start-a-voice-session.md): Create a real-time voice session for an agent. Pass the response `data` to the Chatbase Voice SDK (`@chatbase-co/voice-sdk`) in your client: the SDK connects, publishes the microphone, and the agent joins automatically. Requires a plan with voice mode enabled; voice minutes consume message credits.…
- [Submit a tool result](https://chatbase.co/docs/api-v2/agents/submit-a-tool-result.md): Submit the result of a client-side tool call. Use the toolCallId from the tool-call part in the chat response to identify the tool call.
- [List conversations](https://chatbase.co/docs/api-v2/conversations/list-conversations.md): List conversations for an agent, ordered by createdAt date. Supports cursor-based pagination. Pass `startDate` and/or `endDate` to restrict the results to a createdAt window.
- [Export conversations](https://chatbase.co/docs/api-v2/conversations/export-conversations.md): Export all conversations with full message history for an agent. Includes conversations from all sources. Tool results are sanitized to remove internal data. Supports cursor-based pagination. Pass `conversationId` to fetch a single conversation from any source (widget, API, WhatsApp, etc.). Pass `in…
- [Get a conversation](https://chatbase.co/docs/api-v2/conversations/get-a-conversation.md): Get conversation metadata and its most recent messages. The pagination cursor can be used with the list messages endpoint to fetch older messages. Only returns conversations created through the API. To fetch a conversation from any source (widget, WhatsApp, etc.), use GET /agents/{agentId}/conversat…
- [Pause or resume a conversation](https://chatbase.co/docs/api-v2/conversations/pause-or-resume-a-conversation.md): Pause or resume an ongoing conversation. A paused conversation stops receiving AI replies but still records incoming messages.
- [List conversation messages](https://chatbase.co/docs/api-v2/conversations/list-conversation-messages.md): List all messages in a conversation with cursor-based pagination. Messages are returned in chronological order within each page, paginating backward from newest. The cursor from the get-conversation endpoint works here.
- [List conversations for a user](https://chatbase.co/docs/api-v2/conversations/list-conversations-for-a-user.md): List conversations for a specific user under an agent, ordered by last activity. Supports cursor-based pagination.
- [Update message feedback](https://chatbase.co/docs/api-v2/conversations/update-message-feedback.md): Set or clear feedback on an assistant message. Use "positive" or "negative" to set feedback, or null to remove existing feedback.
- [Get sources summary](https://chatbase.co/docs/api-v2/sources/get-sources-summary.md): Returns aggregated counts and sizes for each source type, plus a flag if the chatbot knowledge base requires a retrain to reflect any changes
- [List sources](https://chatbase.co/docs/api-v2/sources/list-sources.md): Returns a paginated list of sources for an agent. Ticket sources are excluded. For link sources only individual or sitemap/crawl parent links are returned with aggregated children metadata.
- [Create source](https://chatbase.co/docs/api-v2/sources/create-source.md): Creates a new source. Accepts text, qna, and link source types. File sources require a dedicated endpoint. Ticket and Notion sources are not accepted. The source starts training immediately — no separate training call is needed. It is returned as `untrained` and flips to `trained` when it is live, o…
- [Get source](https://chatbase.co/docs/api-v2/sources/get-source.md): Returns a single source by ID.
- [Update source](https://chatbase.co/docs/api-v2/sources/update-source.md): Updates an existing source. Accepts text, qna, and link sources. File sources require a dedicated endpoint. A content change retrains the source immediately (status `updated` until it is live again). Link URL is immutable — to change it, delete and recreate the source. Ticket and Notion sources are…
- [Delete source](https://chatbase.co/docs/api-v2/sources/delete-source.md): Deletes a source. Its knowledge is removed from the agent immediately; the response carries the final state (`deleted`, or `toBeDeleted` while the purge finishes).
- [Restore source (deprecated)](https://chatbase.co/docs/api-v2/sources/restore-source-deprecated.md): **Deprecated.** A delete takes effect immediately — the knowledge is purged right away, so there is no pending state to restore from. The call does nothing and always succeeds. Re-create the source instead.
- [Create file source](https://chatbase.co/docs/api-v2/sources/create-file-source.md): Upload a file as a knowledge source for an agent. Accepts PDF, DOC, DOCX, and TXT files up to 20 MB.
- [Update file source](https://chatbase.co/docs/api-v2/sources/update-file-source.md): Replace a file source's content, rename it, or both. At least one of `name` or `file` must be provided.
- [List WhatsApp templates](https://chatbase.co/docs/api-v2/whatsapp/list-whatsapp-templates.md): Lists the approved WhatsApp templates available to the agent, across all of its connected WhatsApp Business Accounts. Each template's `variables` object is the shape a send request must provide. A template can only be sent from a number on its own Business Account, so pair its `wabaId` with a matchi…
- [Send a WhatsApp template message](https://chatbase.co/docs/api-v2/whatsapp/send-a-whatsapp-template-message.md): Sends an approved WhatsApp template to a recipient from one of the agent's connected phone numbers. Recipients are identified by phone number only — no user ID is required. A Chatbase user is resolved or created from the `to` number automatically, and their reply flows through the agent's regular Wh…
- [List ticket statuses](https://chatbase.co/docs/api-v2/helpdesk/list-ticket-statuses.md): Returns the active (non-archived) ticket statuses configured for an agent, ordered by category then position. Each category has exactly one default status.
- [List teams](https://chatbase.co/docs/api-v2/helpdesk/list-teams.md): Returns the teams configured for an agent, ordered by creation date. Exactly one team is marked as the default for the agent.
- [List tickets](https://chatbase.co/docs/api-v2/helpdesk/list-tickets.md): Returns tickets for an agent, sorted by `updatedAt` descending by default. Supports filtering and cursor-based pagination. Filters combine with AND across parameters.
- [Create a ticket](https://chatbase.co/docs/api-v2/helpdesk/create-a-ticket.md): Creates a ticket on behalf of a customer. Unless an assignee is provided, the ticket is auto-assigned via the agent's routing rules.
- [Search tickets](https://chatbase.co/docs/api-v2/helpdesk/search-tickets.md): Searches ticket messages with a free-text query and returns matching tickets ranked by relevance. Results are capped and not paginated.
- [Get a ticket](https://chatbase.co/docs/api-v2/helpdesk/get-a-ticket.md): Returns a single ticket by its per-agent ticket number.
- [Update a ticket](https://chatbase.co/docs/api-v2/helpdesk/update-a-ticket.md): Partially updates a ticket's status, assignee, team, or priority. Only provided fields are changed. Fields are validated together but written independently, so a 500 can leave a partial update.
- [List ticket messages](https://chatbase.co/docs/api-v2/helpdesk/list-ticket-messages.md): Returns a ticket's message thread in chronological order. Supports cursor-based pagination.
- [Add a message to a ticket](https://chatbase.co/docs/api-v2/helpdesk/add-a-message-to-a-ticket.md): Posts an agent reply to a ticket on behalf of a team member. Delivery to the customer is asynchronous; a 201 confirms the reply was recorded, not delivered. Posting a reply may transition the ticket status, matching dashboard behavior.
- [Chatbase CLI](https://chatbase.co/docs/cli/overview.md): Install and use the official Chatbase CLI to manage agents, sources, conversations, helpdesk, and WhatsApp from your terminal or CI.
- [CLI Auth](https://chatbase.co/docs/cli/auth.md): Authenticate the Chatbase CLI with an API key or browser login, and inspect or remove stored credentials.
- [CLI Config](https://chatbase.co/docs/cli/config.md): Set and inspect Chatbase CLI defaults such as the active agent and request timeout.
- [CLI API](https://chatbase.co/docs/cli/api.md): Call any Chatbase API v2 endpoint from the terminal when no dedicated CLI command exists.
- [CLI Health](https://chatbase.co/docs/cli/health.md): Verify that the Chatbase API is reachable from your terminal or CI pipeline.
- [CLI Agents](https://chatbase.co/docs/cli/agents.md): Create, inspect, update, clone, and delete Chatbase agents from the terminal.
- [CLI Sources](https://chatbase.co/docs/cli/sources.md): Add, list, update, and delete knowledge sources for a Chatbase agent from the terminal.
- [CLI Chat](https://chatbase.co/docs/cli/chat.md): Send messages to an agent, continue conversations, and retry assistant responses from the terminal.
- [CLI Conversations](https://chatbase.co/docs/cli/conversations.md): List, inspect, export, and manage conversation history and message feedback from the terminal.
- [CLI Tickets](https://chatbase.co/docs/cli/tickets.md): Create, triage, search, and reply to helpdesk tickets and look up teams and statuses from the terminal.
- [CLI WhatsApp](https://chatbase.co/docs/cli/whatsapp.md): List approved WhatsApp templates and send template messages to phone numbers from the terminal.
- [Android SDK Overview](https://chatbase.co/docs/android-sdk/overview.md): Introduction to the Chatbase Android SDK — a Kotlin-first library for building conversational AI experiences on Android.
- [Streaming](https://chatbase.co/docs/android-sdk/streaming.md): How to stream real-time responses from the Chatbase Android SDK using callbacks and Kotlin Flow.
- [Client-Side Tools](https://chatbase.co/docs/android-sdk/client-side-tools.md): Register local tool handlers that the agent can invoke during a conversation.
- [Error Handling](https://chatbase.co/docs/android-sdk/error-handling.md): Exception hierarchy and error handling patterns for the Chatbase Android SDK.
- [User Identity](https://chatbase.co/docs/android-sdk/user-identity.md): How to identify users with JWT tokens and manage device-level identity in the Chatbase Android SDK.
- [Conversations & History](https://chatbase.co/docs/android-sdk/conversations.md): Manage conversations, load message history, and navigate paginated results with the Chatbase Android SDK.
- [ChatResponse](https://chatbase.co/docs/android-sdk/chat-response.md): Reference for ChatResponse, ResponseMetadata, Part, and related types returned by sendMessage and retry.
- [Conversation & Message](https://chatbase.co/docs/android-sdk/conversation-models.md): Reference for Conversation, Message, Page, and related types used in conversation history.
- [Streaming Events](https://chatbase.co/docs/android-sdk/streaming-events.md): Reference for ChatStreamEvent, StreamMessageMetadata, ToolCallInfo, and related streaming types.
- [iOS SDK Overview](https://chatbase.co/docs/ios-sdk/overview.md): Introduction to the Chatbase iOS SDK, a Swift library for building conversational AI experiences on iOS and macOS.
- [Streaming](https://chatbase.co/docs/ios-sdk/streaming.md): How to stream real-time replies from the Chatbase iOS SDK with async/await and callbacks.
- [SwiftUI](https://chatbase.co/docs/ios-sdk/swiftui.md): Build a chat screen with ConversationState and ConversationListState, ready-made state that streams into your views.
- [Client-Side Tools](https://chatbase.co/docs/ios-sdk/client-side-tools.md): Let your Chatbase agent run functions on the device during a conversation.
- [Error Handling](https://chatbase.co/docs/ios-sdk/error-handling.md): Error types, codes, and handling patterns for the Chatbase iOS SDK.
- [User Identity](https://chatbase.co/docs/ios-sdk/user-identity.md): How to sign users in with JWT tokens and work with device identity in the Chatbase iOS SDK.
- [Conversations & History](https://chatbase.co/docs/ios-sdk/conversations.md): Manage conversations, load message history, and page through results with the Chatbase iOS SDK.
- [ChatResponse](https://chatbase.co/docs/ios-sdk/chat-response.md): Reference for ChatResponse, Message, MessagePart, FinishReason, and Usage, the types returned by send, retry, and sendNonStreaming.
- [Conversation & Pagination](https://chatbase.co/docs/ios-sdk/conversation-models.md): Reference for Conversation, ConversationStatus, and PaginatedResponse, the types used for conversation history.
- [Streaming Types](https://chatbase.co/docs/ios-sdk/streaming-events.md): Reference for StreamCallbacks, ToolCallInfo, ToolResultInfo, StreamEvent, and related streaming types.
- [JSONValue](https://chatbase.co/docs/ios-sdk/json-value.md): Reference for JSONValue, the type the SDK uses for tool input and output.
- [Frequently Asked Questions](https://chatbase.co/docs/faq/faq.md): Find answers to common questions about Chatbase AI Agents, pricing, features, and technical implementation.

## OpenAPI Specs

- [api-v2-openapi](/docs/api-v2-openapi.json)
- [openapi](/docs/openapi.yaml)
- [package-lock](/docs/package-lock.json)
- [package](/docs/package.json)