# Chatbase - [What is Chatbase? AI agents for customer support](https://chatbase.co/docs/user-guides/quick-start/introduction.md): Build an AI agent trained on your own business data, and deploy it everywhere your customers already are - [Build your first AI agent in minutes](https://chatbase.co/docs/user-guides/quick-start/your-first-agent.md): Create, train, and deploy your first AI agent in a few minutes, and get it live on your website - [Best practices to improve your AI agent's answers](https://chatbase.co/docs/user-guides/quick-start/best-practices.md): Proven ways to improve your AI agent's answers: better instructions, cleaner data sources, the right model, and correcting answers as you go - [Backstage: manage your AI agent with an AI assistant](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 th… - [Preview and test your AI agent in the Playground](https://chatbase.co/docs/user-guides/chatbot/playground.md): Preview your AI agent across supported channels and customize its style and capabilities in real time - [Write your AI agent's instructions and choose its model](https://chatbase.co/docs/user-guides/chatbot/build.md): Write your AI agent's instructions, pick its model and temperature, and compare settings side by side before saving - [Save drafts, publish changes, and restore versions of your AI agent](https://chatbase.co/docs/user-guides/chatbot/versions.md): Stage changes to your AI agent in a draft, publish them when they're ready, and go back to any saved version. - [Train your AI agent on your website, files, and data](https://chatbase.co/docs/user-guides/chatbot/data-sources.md): Add files, websites, text, Q&A, Notion pages, support tickets, and Zendesk macros to train your AI agent, and keep them in sync. - [Deploy your AI agent on your website, messaging apps, and phone](https://chatbase.co/docs/user-guides/chatbot/channels.md): Make your AI agent available across web, messaging, phone, and productivity channels, each configured independently - [AI agent Actions: let your agent take action for customers](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 - [Hand off AI agent conversations to a human](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 - [Hand off conversations to live chat in Chatbase Helpdesk](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 Helpdesk, in real time - [Hand off conversations to live chat in Freshchat](https://chatbase.co/docs/user-guides/chatbot/actions/freshchat-live-chat.md): Hand over from your AI agent to live chat with a human agent in Freshchat - [Custom Actions: connect your AI agent to any API](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: let customers manage subscriptions and billing in chat](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: send customers a link button in chat](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 with your AI agent](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 custom details from customers in chat](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: show clickable reply suggestions in chat](https://chatbase.co/docs/user-guides/chatbot/actions/suggested-messages.md): Display clickable reply suggestions to help customers navigate conversations more efficiently - [Give your AI agent real-time 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 - [Book meetings on Cal.com from your AI agent](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 - [Book meetings on Calendly from your AI agent](https://chatbase.co/docs/user-guides/chatbot/actions/calendly.md): Let customers see your Calendly availability in the chat and pick a slot to book on Calendly - [Send Slack notifications from your AI agent](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: create cases and hand off to live agents](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: products, cart, orders, and returns in chat](https://chatbase.co/docs/user-guides/chatbot/actions/shopify-actions.md): Help customers browse products, manage their cart, place orders, return and exchange items, track deliveries, and update their account through your AI agent - [Show Shopify products as WhatsApp product cards](https://chatbase.co/docs/user-guides/chatbot/actions/whatsapp-catalog.md): Show your Shopify products as native WhatsApp product cards with cart support - [Transfer a voice call from your AI agent to a 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 - [Procedures: step-by-step workflows for your AI agent](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 your AI agent chooses and runs Procedures](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. - [Voice AI agent: set how your agent sounds and behaves on calls](https://chatbase.co/docs/user-guides/chatbot/voice.md): Choose how your AI agent sounds and behaves in voice conversations. - [Guardrails: protect your AI agent from spam and abuse](https://chatbase.co/docs/user-guides/chatbot/guardrails.md): Protect your AI agent from abuse with rate limits, automatic spam detection, and country blocking. - [Contacts: personalize your AI agent for known users](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. - [Upload and manage contacts in Chatbase](https://chatbase.co/docs/user-guides/chatbot/contacts/uploading-contacts.md): Import contacts in bulk from a file, add single contacts, delete contacts, and define custom attributes for your AI agent. - [AI agent settings: general, email, Helpdesk, domains, and webhooks](https://chatbase.co/docs/user-guides/chatbot/settings.md): Configure your AI agent's general details, credit limit, email, Helpdesk, custom fields, custom domains, webhooks, and notifications. - [Set up your AI agent to answer email](https://chatbase.co/docs/user-guides/chatbot/email-settings.md): Use your AI agent over email with agent emails, forwarding rules, and authenticated domains. - [Review your AI agent's conversations, leads, and collected data](https://chatbase.co/docs/user-guides/chatbot/activity.md): Review every conversation your AI agent had, plus the leads and data it collected along the way - [AI agent analytics: chats, topics, sentiment, and Helpdesk metrics](https://chatbase.co/docs/user-guides/chatbot/analytics.md): Aggregate your AI agent's activity into chats, topics, sentiment, Widget and Helpdesk metrics over time - [Outbound campaigns: message your contacts at scale](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. - [Send WhatsApp campaigns with approved message templates](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 workspaces, AI agents, and member permissions](https://chatbase.co/docs/user-guides/workspace/manage.md): Create workspaces, duplicate and group AI agents, and control who can change what - [Track message credit usage across your workspace](https://chatbase.co/docs/user-guides/workspace/usage.md): Track message credits and AI agent counts across your workspace, filtered by AI agent and time period - [Workspace settings: members, plan, billing, and API keys](https://chatbase.co/docs/user-guides/workspace/settings.md): Manage your workspace: details, members, plan, billing, API keys, and audit logs. - [Set up two-factor authentication (2FA) in Chatbase](https://chatbase.co/docs/user-guides/workspace/two-factor-auth.md): Secure your Chatbase account with an authenticator app and one-time recovery codes. - [HIPAA compliance for AI agents on Chatbase](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. - [Chatbase integrations: connect your AI agent to your tools](https://chatbase.co/docs/user-guides/integrations/integrations-overview.md): Connect Chatbase to the platforms you already use: your website, your messaging channels, and your business tools - [Add an AI agent to your Webflow site](https://chatbase.co/docs/user-guides/integrations/webflow.md): Add your Chatbase AI agent to a Webflow site as a floating Chat Bubble or as an inline iframe inside a container you control - [Add an AI agent to your WordPress site](https://chatbase.co/docs/user-guides/integrations/wordpress.md): Add your Chatbase AI agent to a WordPress website using the official Chatbase plugin and your Agent ID - [Add an AI agent to your Wix site](https://chatbase.co/docs/user-guides/integrations/wix.md): Embed your Chatbase AI agent on a Wix website using the website widget embed code - [Add an AI agent to your Weebly site](https://chatbase.co/docs/user-guides/integrations/weebly.md): Embed your Chatbase AI agent inline on a Weebly website using the iframe embed code and the Embed Code element - [Add an AI agent to your Framer site](https://chatbase.co/docs/user-guides/integrations/framer.md): Embed your Chatbase AI agent on a Framer website using the website widget embed code - [Add an AI agent to your Bubble app](https://chatbase.co/docs/user-guides/integrations/bubble.md): Embed your Chatbase AI agent in a Bubble app using the website widget embed code - [Install Chatbase on Vercel from the Vercel Marketplace](https://chatbase.co/docs/user-guides/integrations/vercel.md): Install Chatbase from the Vercel Marketplace to create an AI agent, bill through Vercel, and connect it to your Vercel projects - [Add an AI agent to WhatsApp](https://chatbase.co/docs/user-guides/integrations/whatsapp.md): Connect a WhatsApp number so your AI agent can handle customer conversations on WhatsApp - [Share your WhatsApp Business app number with your AI agent](https://chatbase.co/docs/user-guides/integrations/whatsapp-coexistence.md): Connect the number you already use in the WhatsApp Business app, so your AI agent and your team share it - [Create and send WhatsApp message templates](https://chatbase.co/docs/user-guides/integrations/whatsapp-templates.md): Create approved WhatsApp message templates in WhatsApp Manager and send them from the Chatbase Helpdesk - [Add an AI agent to Facebook Messenger](https://chatbase.co/docs/user-guides/integrations/messenger.md): Connect your Facebook pages so your AI agent can handle Messenger conversations, with human takeover - [Add an AI agent to Instagram direct messages](https://chatbase.co/docs/user-guides/integrations/instagram.md): Connect your Instagram business account so your AI agent can handle direct messages, with human takeover - [Answer phone calls with your AI agent using Twilio](https://chatbase.co/docs/user-guides/integrations/twilio.md): Connect your Twilio account and assign phone numbers so your AI agent can answer inbound calls - [Answer phone calls with your AI agent using a SIP trunk](https://chatbase.co/docs/user-guides/integrations/sip-trunk.md): Connect a number you already own from a PBX, SIP provider, or GSM gateway so your AI agent can answer its calls - [Add your AI agent to Slack](https://chatbase.co/docs/user-guides/integrations/slack.md): Add your AI agent to a Slack workspace so your team can ask it questions in any channel - [Add an AI agent to your Shopify store](https://chatbase.co/docs/user-guides/integrations/shopify.md): Connect your Shopify store so your AI agent can help customers browse, buy, track orders, and manage their account - [Connect Stripe to your AI agent](https://chatbase.co/docs/user-guides/integrations/stripe.md): Connect Stripe so your AI agent can securely show customers their subscriptions, invoices, and billing details - [Connect your AI agent to Zendesk tickets](https://chatbase.co/docs/user-guides/integrations/zendesk.md): Let your AI agent reply to Zendesk tickets directly, or escalate conversations by opening a Zendesk ticket - [Use your AI agent in Zendesk Messaging](https://chatbase.co/docs/user-guides/integrations/zendesk-messaging.md): Let your AI agent answer customers in your Zendesk Messaging channels and hand chats to your team in Zendesk - [Hand off to live Zendesk agents with Sunshine Conversations](https://chatbase.co/docs/user-guides/integrations/sunshine.md): Connect Sunshine Conversations so your AI agent can hand customers to a live human agent in Zendesk - [Escalate AI agent conversations to Freshdesk](https://chatbase.co/docs/user-guides/integrations/freshdesk.md): Connect Freshdesk so your AI agent can escalate a conversation by opening a ticket for your support team - [Hand off AI agent conversations to Freshchat](https://chatbase.co/docs/user-guides/integrations/freshchat.md): Connect Freshchat so your AI agent can hand live conversations over to human agents - [Escalate AI agent conversations to Gorgias](https://chatbase.co/docs/user-guides/integrations/gorgias.md): Connect Gorgias so your AI agent can escalate a conversation by opening a ticket for your support team - [Escalate AI agent conversations to Zoho Desk](https://chatbase.co/docs/user-guides/integrations/zohodesk.md): Connect Zoho Desk so your AI agent can escalate a conversation by opening a ticket for your support team - [Escalate AI agent conversations to Intercom](https://chatbase.co/docs/user-guides/integrations/intercom.md): Connect Intercom so your AI agent can escalate a conversation by opening a ticket for your support team - [Escalate AI agent conversations to HubSpot](https://chatbase.co/docs/user-guides/integrations/hubspot.md): Connect HubSpot so your AI agent can escalate a conversation by opening a ticket for your support team - [Connect your AI agent to Salesforce cases](https://chatbase.co/docs/user-guides/integrations/salesforce.md): Let your AI agent respond to Salesforce cases, or escalate conversations by creating a case for your team - [Escalate AI agent conversations to Help Scout](https://chatbase.co/docs/user-guides/integrations/helpscout.md): Connect Help Scout so your AI agent can escalate a conversation by opening a ticket for your support team - [Escalate AI agent conversations to Odoo Helpdesk](https://chatbase.co/docs/user-guides/integrations/odoo.md): Connect Odoo so your AI agent can escalate a conversation by opening a ticket in Odoo Helpdesk - [Answer customer emails with your AI agent](https://chatbase.co/docs/user-guides/integrations/email.md): Let your AI agent read and reply to customer emails automatically through your company's email system - [Connect your AI agent to Zapier](https://chatbase.co/docs/user-guides/integrations/zapier.md): Connect your AI agent to Zapier to send collected leads into thousands of other apps, or send prompts to your AI agent from a Zap - [Connect your AI agent to viaSocket](https://chatbase.co/docs/user-guides/integrations/viasocket.md): Connect your AI agent to viaSocket with webhooks to automate tasks across your apps, with no code - [Test your AI agent with simulated customers](https://chatbase.co/docs/user-guides/chatbot/tests.md): Check how your AI agent handles a conversation before your customers do. A simulated customer talks to your agent, and each conversation is graded automatically. - [Which AI model should your agent use? Models and credits compared](https://chatbase.co/docs/user-guides/chatbot/models-comparison.md): Compare the recommended AI models by message credit cost, and pick the one that fits your workload - [Chatbase Helpdesk: AI-powered ticketing and live chat](https://chatbase.co/docs/user-guides/chatbot/help-desk/help-desk-overview.md): Manage customer support tickets from a centralized dashboard. - [How a Helpdesk ticket moves from start to finish](https://chatbase.co/docs/user-guides/chatbot/help-desk/ticket-lifecycle.md): What happens to a conversation when a ticket opens, while your team works it, and after you close it. - [Ticket statuses in the Helpdesk](https://chatbase.co/docs/user-guides/chatbot/help-desk/ticket-statuses.md): What each status means, what changes when a ticket moves into it, and how to add your own. - [Filter tickets in the Helpdesk inbox](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 Helpdesk inbox. - [Save custom inbox views in the Helpdesk](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. - [Export Helpdesk tickets to CSV](https://chatbase.co/docs/user-guides/chatbot/help-desk/exporting-tickets.md): Download the tickets in a view as a CSV file. - [Set ticket priority in the Helpdesk](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. - [Tag tickets in the Helpdesk](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. - [Merge duplicate tickets in the Helpdesk](https://chatbase.co/docs/user-guides/chatbot/help-desk/merging-tickets.md): Combine duplicate tickets from the same customer so your team works on one. - [Add follow-ups to a customer's open ticket](https://chatbase.co/docs/user-guides/chatbot/help-desk/ticket-reuse.md): Keep a customer's new emails and chats on the ticket they already have open. - [Helpdesk email settings: addresses, signatures, and display names](https://chatbase.co/docs/user-guides/chatbot/help-desk/email-settings.md): Configure email addresses, display names, signatures, and previews for your Helpdesk. - [Create support teams in the Helpdesk](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. - [Assign Helpdesk tickets automatically](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. - [Schedule agent shifts and time off in the Helpdesk](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. - [Track agent attendance in the Helpdesk](https://chatbase.co/docs/user-guides/chatbot/help-desk/attendance.md): See who worked their scheduled hours on a given day, and export it. - [See each Helpdesk agent's daily activity](https://chatbase.co/docs/user-guides/chatbot/help-desk/activity.md): See what each operator was doing through the day, ticket by ticket, and export it. - [See what each Helpdesk agent is doing right now](https://chatbase.co/docs/user-guides/chatbot/help-desk/live-status.md): See what each operator is doing right now, and whether it matches their shift. - [Automate the Helpdesk with triggers](https://chatbase.co/docs/user-guides/chatbot/help-desk/triggers.md): Automate your Helpdesk with ordered rules that run when tickets are created or updated, setting statuses, routing work, and adding notes for you. - [Automations](https://chatbase.co/docs/user-guides/chatbot/help-desk/automations.md): Close, reassign, tag or notify tickets that have waited too long. Automations check your open tickets once an hour. - [Reply to Helpdesk tickets from Slack threads](https://chatbase.co/docs/user-guides/chatbot/help-desk/slack-ticket-threads.md): Give every new ticket its own Slack thread, so your team can reply to customers, add internal notes, assign, and close tickets without leaving Slack. - [Collect custom ticket fields with your AI agent](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 Helpdesk. - [Translate customer messages automatically in the Helpdesk](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. - [Draft ticket replies with AI in the Helpdesk](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. - [Save reply templates (macros) in the Helpdesk](https://chatbase.co/docs/user-guides/chatbot/help-desk/macros.md): Save the replies your team writes every day and insert them into any ticket from the composer. - [Helpdesk keyboard shortcuts](https://chatbase.co/docs/user-guides/chatbot/help-desk/keyboard-shortcuts.md): Move between tickets, reply, and triage from the keyboard. - [Send customer satisfaction (CSAT) surveys after tickets close](https://chatbase.co/docs/user-guides/chatbot/help-desk/satisfaction-surveys.md): Email a short rating survey after each Helpdesk ticket closes, and track your team's CSAT score in analytics. - [Take over AI agent conversations as a human](https://chatbase.co/docs/user-guides/chatbot/help-desk/takeover.md): Take over AI conversations and escalate them to Helpdesk tickets for human support. - [See Shopify orders inside Helpdesk tickets](https://chatbase.co/docs/user-guides/chatbot/help-desk/integrations/shopify.md): See a customer's Shopify order history right inside the ticket. - [Create Linear issues from Helpdesk tickets](https://chatbase.co/docs/user-guides/chatbot/help-desk/integrations/linear.md): Connect Linear so your team can create Linear issues from Helpdesk tickets - [Chatbase Experts Program for agencies and freelancers](https://chatbase.co/docs/user-guides/chatbase-experts/experts-program.md): Build AI agents for clients in an agency workspace, copy them to each client's Chatbase workspace, and earn commissions. - [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. - [REST API Integration](https://chatbase.co/docs/developer-guides/api-integration.md): Complete guide to integrating Chatbase AI Agents using the Chatbase API v2 for custom integrations and applications. - [Website Integration Overview](https://chatbase.co/docs/developer-guides/website-integration/overview.md): Add your Chatbase AI agent to your website with the Chat Bubble or Center Stage. - [Chat Bubble Installation](https://chatbase.co/docs/developer-guides/website-integration/chat-bubble.md): Complete guide to embedding Chatbase AI Agents in your web application with advanced customization options. - [Iframe Developer Guide](https://chatbase.co/docs/developer-guides/website-integration/iframe.md): Embed your AI agent with a plain iframe or a mobile WebView and control it with postMessage: identity, metadata, resets, events, client-side Actions and forms. - [Identity Verification](https://chatbase.co/docs/developer-guides/website-integration/identity-verification.md): Authenticate users in your AI Agent widget just like they're authenticated on your website. - [UTM Tracking](https://chatbase.co/docs/developer-guides/website-integration/utm-tracking.md): Keep campaign attribution on links your AI Agent shares. - [Client-Side Custom Actions](https://chatbase.co/docs/developer-guides/website-integration/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/website-integration/client-side-custom-forms.md): Create dynamic, interactive forms in your AI agent using client-side JavaScript configuration - [Chat Interface Control](https://chatbase.co/docs/developer-guides/website-integration/chat-interface-control.md): Programmatically control your website chat interface with JavaScript methods to open, close, reset conversations, and override configured options at runtime. - [Event Listeners](https://chatbase.co/docs/developer-guides/website-integration/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/website-integration/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/website-integration/floating-initial-messages.md): Create eye-catching floating messages that appear above your chat widget to welcome visitors and boost engagement - [MCP Server](https://chatbase.co/docs/developer-guides/mcp.md): Connect Claude, ChatGPT, Codex, Cursor and other MCP clients to your Chatbase workspace over OAuth. - [MCP Events](https://chatbase.co/docs/developer-guides/mcp-events.md): Let ChatGPT and other MCP clients react when a ticket is created, a conversation escalates, a customer replies or a phone call ends. - [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. - [Help Page Proxy](https://chatbase.co/docs/developer-guides/help-page-proxy.md): Show your Chatbase Help Page on your own domain, like your-domain.com/help, using rewrites (proxies). - [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. - [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. - [File Uploads](https://chatbase.co/docs/developer-guides/widgets/file-uploads.md): Let visitors upload files from a Widget straight to your own endpoint, then use the uploaded file URLs in the Widget. - [Click Tracking](https://chatbase.co/docs/developer-guides/widgets/click-tracking.md): See how often visitors use the buttons, links and fields in your Widgets, and the click-through rate of each one. - [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, Slider, Dropzone, and FileInput. - [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-reference/v2/overview.md): Introduction to the Chatbase API v2 — a structured, modern REST API for chatting with AI agents and managing conversations. - [Authentication](https://chatbase.co/docs/api-reference/v2/authentication.md): How to authenticate with the Chatbase API v2 using Bearer tokens, and understand rate limiting. - [Streaming](https://chatbase.co/docs/api-reference/v2/streaming.md): How to use Server-Sent Events (SSE) streaming with the Chatbase API v2 for real-time responses. - [Error Handling](https://chatbase.co/docs/api-reference/v2/error-handling.md): Structured error codes and troubleshooting guide for the Chatbase API v2. - [Pagination](https://chatbase.co/docs/api-reference/v2/pagination.md): How cursor-based pagination works in the Chatbase API v2. - [Agents](https://chatbase.co/docs/api-reference/v2/agents.md): Programmatically create, configure, and manage your Chatbase AI agents. - [User Conversations](https://chatbase.co/docs/api-reference/v2/user-conversations.md): Associate users with conversations, manage per-user history, and export full conversation data across all sources. - [Conversation Search](https://chatbase.co/docs/api-reference/v2/conversation-search.md): Find an AI agent's conversations by what was said, what happened, or both, across every source. - [Sources](https://chatbase.co/docs/api-reference/v2/sources.md): Programmatically manage the knowledge sources that power your Chatbase AI agent — web pages, documents, Q&A pairs, and text. - [Helpdesk](https://chatbase.co/docs/api-reference/v2/helpdesk.md): Programmatically create, triage, and reply to support tickets, and read your operators' attendance and activity, for your Chatbase AI agents. - [WhatsApp](https://chatbase.co/docs/api-reference/v2/whatsapp.md): List the approved WhatsApp templates available to your AI agent and send them to any phone number. - [Voice Sessions](https://chatbase.co/docs/api-reference/v2/voice.md): Embed real-time voice conversations with your AI agent in your own app using the Voice Sessions API and the Chatbase Voice SDK. - [Client Actions](https://chatbase.co/docs/api-reference/v2/client-actions.md): Handle client-side actions invoked by your AI agent through the Chatbase API v2. - [Health check](https://chatbase.co/docs/api-reference/v2/health/health-check.md): Returns the API health status. No authentication required. - [List agents](https://chatbase.co/docs/api-reference/v2/agents/list-agents.md): Returns a paginated list of all agents for the authenticated account. - [Create agent](https://chatbase.co/docs/api-reference/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-reference/v2/agents/get-agent.md): Returns a single agent by ID. - [Update agent](https://chatbase.co/docs/api-reference/v2/agents/update-agent.md): Partially updates an agent. Only provided fields are changed. - [Delete agent](https://chatbase.co/docs/api-reference/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-reference/v2/agents/update-agent-styles.md): Updates the visual styles for an agent. - [Toggle auto-retrain](https://chatbase.co/docs/api-reference/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-reference/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-reference/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… - [Get agent analytics](https://chatbase.co/docs/api-reference/v2/agents/get-agent-analytics.md): Returns an agent's activity over a date range split into 7 equal buckets: conversations, messages, sentiment, escalations, ratings, help desk tickets, procedure runs, tool calls and action types per bucket. For the whole range it adds conversation counts by source, action, country, answer confidence… - [Chat with an agent](https://chatbase.co/docs/api-reference/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-reference/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-reference/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-reference/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-reference/v2/conversations/list-conversations.md): List conversations created through the API for an agent, ordered by createdAt date. Conversations from other sources (widget, WhatsApp, etc.) are not included; use Search conversations or Export conversations for those. Supports cursor-based pagination. Pass `startDate` and/or `endDate` to restrict… - [Export conversations](https://chatbase.co/docs/api-reference/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… - [Search conversations](https://chatbase.co/docs/api-reference/v2/conversations/search-conversations.md): Search an agent's conversations by text, filters, or both. With `query`, results are ranked and carry a highlighted snippet; without it, most recently active first. Filters combine with AND; comma-separated values within a filter with OR. Covers conversations created since the 1st of the month 12 mo… - [Get a conversation](https://chatbase.co/docs/api-reference/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… - [Delete conversation](https://chatbase.co/docs/api-reference/v2/conversations/delete-conversation.md): Deletes a conversation from any source (API, widget, WhatsApp, etc.). It no longer appears in chat logs or in API responses. - [Update conversation status](https://chatbase.co/docs/api-reference/v2/conversations/update-conversation-status.md): Update the activity state of a conversation. - [List conversation messages](https://chatbase.co/docs/api-reference/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-reference/v2/conversations/list-conversations-for-a-user.md): List conversations created through the API for a specific user under an agent, ordered by last activity. Conversations from other sources (widget, WhatsApp, etc.) are not included; use Search conversations with `userId` to find them, and Export conversations to read their messages. Supports cursor-b… - [Delete all conversations for a user](https://chatbase.co/docs/api-reference/v2/conversations/delete-all-conversations-for-a-user.md): Deletes every conversation of a user under an agent, from any source (API, widget, WhatsApp, etc.). They no longer appear in chat logs or in API responses. Deleting a contact does not delete their conversations; call this endpoint as well. - [Update message feedback](https://chatbase.co/docs/api-reference/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. - [List collected data](https://chatbase.co/docs/api-reference/v2/collected-data/list-collected-data.md): Returns the data an agent's Collect data Actions have saved, newest first. Filter by Action with `actionId` and by submission time with `startDate` / `endDate`. Supports cursor-based pagination. - [Get sources summary](https://chatbase.co/docs/api-reference/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-reference/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-reference/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-reference/v2/sources/get-source.md): Returns a single source by ID. - [Update source](https://chatbase.co/docs/api-reference/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-reference/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-reference/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-reference/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-reference/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 actions](https://chatbase.co/docs/api-reference/v2/actions/list-actions.md): Returns a paginated list of an agent's actions, sorted by name. Action configuration is not included. - [Get an action](https://chatbase.co/docs/api-reference/v2/actions/get-an-action.md): Returns one action, including when the agent should use it, the fields it collects and the channels it can run on. Other configuration is not included. - [Delete an action](https://chatbase.co/docs/api-reference/v2/actions/delete-an-action.md): Deletes an action from the live agent at once. Refused while any procedure mentions it; remove the mention first. Publishing an older draft can bring it back. - [Update an action](https://chatbase.co/docs/api-reference/v2/actions/update-an-action.md): Updates an action's name, status, whenToUse, procedureOnly, per-channel switches, or the inputs it collects. A draft cannot be set to disabled; finishing its setup turns it off, and status enabled turns it on only once setup is complete. whenToUse is required unless the action is procedure-only, and… - [List procedures](https://chatbase.co/docs/api-reference/v2/procedures/list-procedures.md): Returns a paginated list of an agent's procedures, newest first. Steps are not included. - [Create a procedure](https://chatbase.co/docs/api-reference/v2/procedures/create-a-procedure.md): Creates a procedure on the live agent. It starts disabled; enable it with an update once every action its steps mention exists and is enabled. Publishing an older draft can remove it. - [Get a procedure](https://chatbase.co/docs/api-reference/v2/procedures/get-a-procedure.md): Returns one procedure, including its steps. - [Delete a procedure](https://chatbase.co/docs/api-reference/v2/procedures/delete-a-procedure.md): Deletes a procedure from the live agent at once, together with its run history. Publishing an older draft can bring the procedure back, but not its history. - [Update a procedure](https://chatbase.co/docs/api-reference/v2/procedures/update-a-procedure.md): Updates a procedure's name, trigger, steps or status. Properties you leave out keep their value, but `steps` replaces all steps. Enabling needs every action the steps mention to exist and be enabled. Changes apply to the live agent at once; publishing an older draft can undo them. - [List WhatsApp templates](https://chatbase.co/docs/api-reference/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-reference/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… - [Send an event](https://chatbase.co/docs/api-reference/v2/events/send-an-event.md): Records an event about a person or a mission run. Missions use events to start, wake and end runs. - [List ticket statuses](https://chatbase.co/docs/api-reference/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-reference/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 attendance rows](https://chatbase.co/docs/api-reference/v2/helpdesk/list-attendance-rows.md): Returns the Attendance report for each day in the range: one row per operator for each part of a shift and for time logged outside them, matching the Attendance CSV export. Days are calendar days in `timezone`. A day that has not ended yet returns what has happened so far. Pages can shift if the dat… - [List activity segments](https://chatbase.co/docs/api-reference/v2/helpdesk/list-activity-segments.md): Returns the stored activity segments of the agent's current Help Desk operators, unmerged and unrounded, so totals can differ slightly from the Activity export. One item per ticket, untracked or idle stretch, listed only in the range where it started. Both reports share a limit of 30 calls per 10 se… - [List tickets](https://chatbase.co/docs/api-reference/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-reference/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-reference/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-reference/v2/helpdesk/get-a-ticket.md): Returns a single ticket by its per-agent ticket number. - [Update a ticket](https://chatbase.co/docs/api-reference/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-reference/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-reference/v2/helpdesk/add-a-message-to-a-ticket.md): Posts an agent reply or internal note to a ticket on behalf of a team member. Reply 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. Notes are never delivered to the customer… - [API v1 Overview](https://chatbase.co/docs/api-reference/v1/overview.md): Reference for the deprecated Chatbase API v1. API v1 still works for existing integrations. - [Chat with a chatbot](https://chatbase.co/docs/api-reference/v1/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/v1/chatbots/create-a-new-chatbot.md): Creates a new chatbot with training data from text - [Get all chatbots](https://chatbase.co/docs/api-reference/v1/chatbots/get-all-chatbots.md): Retrieves all chatbots for the authenticated account - [Delete a chatbot](https://chatbase.co/docs/api-reference/v1/chatbots/delete-a-chatbot.md): Permanently deletes a chatbot and all associated data - [Update a chatbot](https://chatbase.co/docs/api-reference/v1/chatbots/update-a-chatbot.md): Updates and retrains a chatbot with new content - [Update chatbot settings](https://chatbase.co/docs/api-reference/v1/chatbots/update-chatbot-settings.md): Updates various chatbot configuration settings - [Get conversations for a chatbot](https://chatbase.co/docs/api-reference/v1/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/v1/leads/get-leads-for-a-chatbot.md): Retrieves collected leads/customers for a specific chatbot - [Upload chatbot icon](https://chatbase.co/docs/api-reference/v1/assets/upload-chatbot-icon.md): Uploads an icon image for the chatbot - [Upload chatbot profile picture](https://chatbase.co/docs/api-reference/v1/assets/upload-chatbot-profile-picture.md): Uploads a profile picture for the chatbot - [Delete chatbot icon](https://chatbase.co/docs/api-reference/v1/assets/delete-chatbot-icon.md): Deletes the chatbot's icon image - [Delete chatbot profile picture](https://chatbase.co/docs/api-reference/v1/assets/delete-chatbot-profile-picture.md): Deletes the chatbot's profile picture - [Get contacts for a chatbot](https://chatbase.co/docs/api-reference/v1/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/v1/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/v1/contacts/get-a-specific-contact.md): Retrieves a single contact by ID - [Delete a contact](https://chatbase.co/docs/api-reference/v1/contacts/delete-a-contact.md): Permanently deletes a contact - [Update a contact](https://chatbase.co/docs/api-reference/v1/contacts/update-a-contact.md): Updates an existing contact's information - [Get custom attributes schema](https://chatbase.co/docs/api-reference/v1/contacts/get-custom-attributes-schema.md): Retrieves the custom attributes schema for contacts - [Create custom attribute](https://chatbase.co/docs/api-reference/v1/contacts/create-custom-attribute.md): Creates a new custom attribute for contacts - [Update custom attribute](https://chatbase.co/docs/api-reference/v1/contacts/update-custom-attribute.md): Updates an existing custom attribute - [Chatbase CLI](https://chatbase.co/docs/cli/overview.md): Install and use the official Chatbase CLI to manage AI 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 AI 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 AI agents from the terminal. - [CLI Sources](https://chatbase.co/docs/cli/sources.md): Add, list, update, and delete knowledge sources for a Chatbase AI agent from the terminal. - [CLI Chat](https://chatbase.co/docs/cli/chat.md): Send messages to an AI 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. - [SDKs Overview](https://chatbase.co/docs/sdks/overview.md): Add Chatbase AI agents to native Android and iOS apps with the Chatbase mobile SDKs. - [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. - [Installation & Quickstart](https://chatbase.co/docs/android-sdk/quickstart.md): Install the Chatbase Android SDK and send your first message. - [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 AI 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. - [Chatbase](https://chatbase.co/docs/android-sdk/chatbase.md): Create SDK clients with Chatbase and configure them with ChatbaseConfig in 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. - [Installation & Quickstart](https://chatbase.co/docs/ios-sdk/quickstart.md): Install the Chatbase iOS SDK and send your first message. - [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 AI 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. - [ChatbaseClient](https://chatbase.co/docs/ios-sdk/chatbase-client.md): Initializer, properties, and methods of ChatbaseClient, the main entry point of 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) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.