# Chatbase

## Docs

- [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
- [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
- [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
- [Delete a chatbot](https://chatbase.co/docs/api-reference/chatbots/delete-a-chatbot.md): Permanently deletes a chatbot and all associated data
- [Get all chatbots](https://chatbase.co/docs/api-reference/chatbots/get-all-chatbots.md): Retrieves all chatbots for the authenticated account
- [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
- [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)
- [Create custom attribute](https://chatbase.co/docs/api-reference/contacts/create-custom-attribute.md): Creates a new custom attribute for contacts
- [Delete a contact](https://chatbase.co/docs/api-reference/contacts/delete-a-contact.md): Permanently deletes a contact
- [Get a specific contact](https://chatbase.co/docs/api-reference/contacts/get-a-specific-contact.md): Retrieves a single contact by ID
- [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
- [Get custom attributes schema](https://chatbase.co/docs/api-reference/contacts/get-custom-attributes-schema.md): Retrieves the custom attributes schema for contacts
- [Update a contact](https://chatbase.co/docs/api-reference/contacts/update-a-contact.md): Updates an existing contact's information
- [Update custom attribute](https://chatbase.co/docs/api-reference/contacts/update-custom-attribute.md): Updates an existing custom attribute
- [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
- [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.
- [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.
- [Authentication](https://chatbase.co/docs/api-v2/authentication.md): How to authenticate with the Chatbase API v2 using Bearer tokens, and understand rate limiting.
- [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.
- [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.
- [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](https://chatbase.co/docs/api-v2/conversations/list-conversations.md): List conversations for an agent, ordered by createdAt date. Supports cursor-based pagination.
- [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.
- [Error Handling](https://chatbase.co/docs/api-v2/error-handling.md): Structured error codes and troubleshooting guide for the Chatbase API v2.
- [Health check](https://chatbase.co/docs/api-v2/health/health-check.md): Returns the API health status. No authentication required.
- [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.
- [Pagination](https://chatbase.co/docs/api-v2/pagination.md): How cursor-based pagination works in the Chatbase API v2.
- [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.
- [User Conversations](https://chatbase.co/docs/api-v2/user-conversations.md): How to associate users with conversations and manage per-user conversation history.
- [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.
- [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.
- [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 chatbot using client-side JavaScript configuration
- [Widget Control](https://chatbase.co/docs/developer-guides/control-widget.md): Programmatically control your chat widget with JavaScript methods to open, close, and reset conversations.
- [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.
- [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
- [Help Page Proxy](https://chatbase.co/docs/developer-guides/help-page-proxy.md)
- [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.
- [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.
- [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.
- [Webhook API Guide](https://chatbase.co/docs/developer-guides/webhooks.md): Guide to setting up webhooks to receive real-time notifications when users submit your custom forms.
- [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.
- [Data Display](https://chatbase.co/docs/developer-guides/widgets/components/data-display.md): Components for displaying structured data — Table and Chart.
- [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, and RadioGroup.
- [Interactive](https://chatbase.co/docs/developer-guides/widgets/components/interactive.md): Interactive components for user actions — Button.
- [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.
- [Media & Visual](https://chatbase.co/docs/developer-guides/widgets/components/media.md): Visual components for icons, images, badges, and animations.
- [Text](https://chatbase.co/docs/developer-guides/widgets/components/text.md): Text components for displaying content — Text, Title, Caption, Label, and Markdown.
- [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.
- [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.
- [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.
- [Frequently Asked Questions](https://chatbase.co/docs/faq/faq.md): Find answers to common questions about Chatbase AI Agents, pricing, features, and technical implementation.
- [Chatbase Experts Program](https://chatbase.co/docs/user-guides/chatbase-experts/experts-program.md)
- [Overview](https://chatbase.co/docs/user-guides/chatbot/actions/actions-overview.md): AI actions are a set of functions or tasks that your AI agent can trigger or execute during a conversation with users. These actions enhance the conversational experience, improve efficiency, and allow the AI agent to go beyond just responding to queries. Some of these actions may include performing…
- [Cal.com](https://chatbase.co/docs/user-guides/chatbot/actions/cal.md)
- [Calendly](https://chatbase.co/docs/user-guides/chatbot/actions/calendly.md)
- [Collect Leads](https://chatbase.co/docs/user-guides/chatbot/actions/collect-leads.md)
- [Custom Action](https://chatbase.co/docs/user-guides/chatbot/actions/custom-action.md)
- [Custom Button](https://chatbase.co/docs/user-guides/chatbot/actions/custom-button.md)
- [Escalate to Human](https://chatbase.co/docs/user-guides/chatbot/actions/escalate-to-human.md)
- [Salesforce Actions](https://chatbase.co/docs/user-guides/chatbot/actions/salesforce-actions.md): Create support tickets and connect users to live agents in Salesforce when your AI agent needs to escalate customer issues
- [Shopify Actions](https://chatbase.co/docs/user-guides/chatbot/actions/shopify-actions.md): Help customers browse products, track orders, manage their cart, and update their account through your AI agent
- [Slack](https://chatbase.co/docs/user-guides/chatbot/actions/slack.md)
- [Stripe Actions](https://chatbase.co/docs/user-guides/chatbot/actions/stripe-action.md): Automate billing and subscription management with powerful Stripe actions
- [Web Search](https://chatbase.co/docs/user-guides/chatbot/actions/web-search.md)
- [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)
- [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.
- [Getting Started](https://chatbase.co/docs/user-guides/chatbot/contacts/getting-started.md): Learn how to get started with the Contacts API
- [Data sources](https://chatbase.co/docs/user-guides/chatbot/data-sources.md)
- [Deploy](https://chatbase.co/docs/user-guides/chatbot/deploy.md): Deploy your Chatbase agent across web, messaging, phone, and productivity channels.
- [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.
- [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.
- [Email Settings](https://chatbase.co/docs/user-guides/chatbot/help-desk/email-settings.md): Configure email addresses, display names, signatures, and previews for your Help Desk.
- [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.
- [Overview](https://chatbase.co/docs/user-guides/chatbot/help-desk/help-desk-overview.md): Manage customer support tickets from a centralized dashboard.
- [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.
- [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.
- [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.
- [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.
- [Models Comparison](https://chatbase.co/docs/user-guides/chatbot/models-comparison.md)
- [Playground](https://chatbase.co/docs/user-guides/chatbot/playground.md): Test and optimize your AI agent before deployment. Compare different AI models, adjust settings like temperature and system prompts, and evaluate responses to ensure your agent performs exactly as needed for your users.
- [Settings](https://chatbase.co/docs/user-guides/chatbot/settings.md)
- [Bubble](https://chatbase.co/docs/user-guides/integrations/bubble.md)
- [Email](https://chatbase.co/docs/user-guides/integrations/email.md): Enable AI-powered email responses with automated customer support through email
- [Framer](https://chatbase.co/docs/user-guides/integrations/framer.md)
- [Freshdesk](https://chatbase.co/docs/user-guides/integrations/freshdesk.md)
- [Help Scout](https://chatbase.co/docs/user-guides/integrations/helpscout.md)
- [HubSpot](https://chatbase.co/docs/user-guides/integrations/hubspot.md): Connect HubSpot to Chatbase so your AI agent can create tickets.
- [Instagram](https://chatbase.co/docs/user-guides/integrations/instagram.md)
- [Intercom](https://chatbase.co/docs/user-guides/integrations/intercom.md)
- [Messenger](https://chatbase.co/docs/user-guides/integrations/messenger.md)
- [Salesforce](https://chatbase.co/docs/user-guides/integrations/salesforce.md)
- [Shopify](https://chatbase.co/docs/user-guides/integrations/shopify.md)
- [Slack](https://chatbase.co/docs/user-guides/integrations/slack.md)
- [Stripe](https://chatbase.co/docs/user-guides/integrations/stripe.md)
- [Sunshine](https://chatbase.co/docs/user-guides/integrations/sunshine.md)
- [Twilio (Phone)](https://chatbase.co/docs/user-guides/integrations/twilio.md)
- [Vercel](https://chatbase.co/docs/user-guides/integrations/vercel.md): Install Chatbase AI Agent directly from the Vercel Marketplace with one-click integration
- [ViaSocket](https://chatbase.co/docs/user-guides/integrations/viasocket.md)
- [Webflow](https://chatbase.co/docs/user-guides/integrations/webflow.md)
- [Weebly](https://chatbase.co/docs/user-guides/integrations/weebly.md)
- [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.
- [Wix](https://chatbase.co/docs/user-guides/integrations/wix.md)
- [WordPress](https://chatbase.co/docs/user-guides/integrations/wordpress.md)
- [Zapier](https://chatbase.co/docs/user-guides/integrations/zapier.md)
- [Zendesk](https://chatbase.co/docs/user-guides/integrations/zendesk.md)
- [Zoho Desk](https://chatbase.co/docs/user-guides/integrations/zohodesk.md)
- [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 bot how to send links.
- [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.
- [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.
- [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.
- [Manage  ](https://chatbase.co/docs/user-guides/workspace/manage.md): Organize your users in Chatbase workspaces for better collaboration and permission control.
- [Settings](https://chatbase.co/docs/user-guides/workspace/settings.md): This page provides all the details for the specified workspace, including member information, plan and billing details, Chatbase API keys, and API keys for the external LLM.
- [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.
- [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.

## OpenAPI Specs

- [openapi](https://chatbase.co/docs/openapi.yaml)
- [api-v2-openapi](https://chatbase.co/docs/api-v2-openapi.json)
- [package](https://chatbase.co/docs/package.json)
- [package-lock](https://chatbase.co/docs/package-lock.json)