# Botpress ## Docs - [Welcome to Botpress](https://botpress-charmenta-pr-696.mintlify.site/index.md) - [Quickstart](https://botpress-charmenta-pr-696.mintlify.site/get-started/quick-start.md): Build, test, and deploy your first AI agent. - [Preview](https://botpress-charmenta-pr-696.mintlify.site/get-started/manage-your-agent/preview.md) - [Monitor performance](https://botpress-charmenta-pr-696.mintlify.site/get-started/manage-your-agent/monitor.md) - [Add knowledge sources](https://botpress-charmenta-pr-696.mintlify.site/get-started/manage-your-agent/knowledge.md) - [Inspect behaviour](https://botpress-charmenta-pr-696.mintlify.site/get-started/manage-your-agent/inspect.md) - [Configure Human Handoff](https://botpress-charmenta-pr-696.mintlify.site/get-started/manage-your-agent/human-handoff.md) - [Edit appearance](https://botpress-charmenta-pr-696.mintlify.site/get-started/manage-your-agent/edit-appearance.md) - [Control access to your agent](https://botpress-charmenta-pr-696.mintlify.site/get-started/manage-your-agent/control-access.md) - [Configure your workspace](https://botpress-charmenta-pr-696.mintlify.site/get-started/configure-your-workspace.md) - [Botpress ADK](https://botpress-charmenta-pr-696.mintlify.site/adk.md) - [Introduction to Studio](https://botpress-charmenta-pr-696.mintlify.site/studio/introduction.md): Development environment for building AI agents and chatbots. - [Home](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/home.md): Main menu with global configuration for your bot. - [Nodes](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/nodes/introduction.md) - [Autonomous Node](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/nodes/autonomous-node.md) - [Cards](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/cards/introduction.md) - [Send Messages](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/cards/send-messages.md) - [Execute Code](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/cards/execute-code.md) - [Tables](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/cards/tables.md) - [Set inactivity timeout](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/cards/set-inactivity-timeout.md) - [Webchat](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/cards/webchat.md): Cards that allow you to interact with the Webchat widget. - [Flow Logic](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/cards/flow-logic.md) - [AI](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/cards/ai/introduction.md): These cards use AI by default to power their actions. - [AI Task](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/cards/ai/ai-task.md): Perform specific and defined AI-powered actions in your bot's Workflow. - [AI Transition](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/cards/ai/ai-transition.md): Transition card that uses AI to determine a user's intent from a natural language input. - [AI Generate Text](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/cards/ai/ai-generate-text.md): A card that allows you to define a custom prompt to generate text. - [Capture Information](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/cards/capture-information.md): Cards that stop the bot's Workflow and waits for a user's response to capture specific pieces of information. - [Fixed Schedule](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/cards/fixed-schedule.md): Schedule a part of your Workflow. - [Agents](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/cards/agents.md): Cards that interact with specific Agent functionalities. - [Utilities](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/cards/utilities.md): Cards that provide utility in the Studio, and aren't part of your bot's Workflow. - [Workflows](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/workflows.md) - [Knowledge Bases](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/knowledge-base/introduction.md) - [Add sources to Knowledge Base](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/knowledge-base/add-sources.md) - [Knowledge Base Best Practices](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/knowledge-base/knowledge-base-best-practices.md): Set up Knowledge Bases effectively by prioritizing structured data, ensuring data quality, and using automated ingestion tools. - [Tables](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/tables.md) - [Actions](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/actions.md) - [Agents](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/agents/introduction.md): Specialized components that extend the capabilities of a bot. - [Summary Agent](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/agents/summary-agent.md): Condenses the conversation into an AI-generated summary and transcript. - [Personality Agent](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/agents/personality-agent.md): Provides your bot with a personality or tone. - [Policy Agent](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/agents/policy-agent.md): Enforces business rules and compliance guidelines across your bot's interactions. - [Translator Agent](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/agents/translator-agent.md): Enables your bot to communicate in multiple languages. - [Knowledge Agent](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/agents/knowledge-agent.md): Retrieves information from the bot's knowledge base. - [HITL Agent](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/agents/hitl-agent.md): Allows human intervention in the bot's conversations and decision-making. - [Vision Agent](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/agents/vision-agent.md): Adds image recognition and visual processing capabilities to your bot. - [Analytics Agent](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/agents/analytics-agent.md): Collects, analyzes, and stores data on bot interactions. - [Hooks](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/hooks.md) - [Hub](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/card-hub.md): Download and install integrations with external services or premade Workflows from across the web. - [Integrations](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/integrations.md): Allow your bot to connect to external services, APIs, and tools. - [Schemas](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/schemas.md): Blueprint that defines the structure, format, and validation rules for data. - [Versions](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/versions.md): View, compare, and revert to previous versions of your bot. - [Bot Settings](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/bot-settings.md) - [Find](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/find.md): Quickly search through your bot's content, Workflows, and configurations. - [Variables](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/variables/overview.md): Containers for storing and reusing information in Botpress Studio. - [Workflow variables](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/variables/scopes/workflow.md) - [User variables](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/variables/scopes/user.md) - [Conversation variables](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/variables/scopes/conversation.md) - [Bot variables](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/variables/scopes/bot.md) - [Configuration variables](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/variables/scopes/configuration.md) - [Built-in variables](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/variables/built-in.md) - [Pass variables between Workflows](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/variables/pass-between-workflows.md) - [Use variables in code](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/variables/in-code.md) - [Triggers](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/triggers.md) - [Debugger, Logs & JSON](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/debugger-logs-json.md) - [Emulator](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/emulator.md) - [Import & Export](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/import-export-bots.md) - [Copy to bot](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/copy-to-bot.md): Duplicate the configuration of a bot into another bot. - [Keyboard Shortcuts](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/controls-and-settings/keyboard-shortcuts.md): Studio Keyboard Shortcuts - [Commands](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/controls-and-settings/studio-commands.md) - [Studio Preferences](https://botpress-charmenta-pr-696.mintlify.site/studio/concepts/controls-and-settings/studio-preferences.md) - [Introduction](https://botpress-charmenta-pr-696.mintlify.site/studio/guides/introduction.md) - [Translate Webchat UI](https://botpress-charmenta-pr-696.mintlify.site/studio/guides/how-to/translate.md) - [Send reminders to conversations](https://botpress-charmenta-pr-696.mintlify.site/studio/guides/how-to/send-reminders.md) - [Use different LLM for Autonomous Nodes](https://botpress-charmenta-pr-696.mintlify.site/studio/guides/how-to/different-an-models.md) - [Track AI spend in a table](https://botpress-charmenta-pr-696.mintlify.site/studio/guides/how-to/track-ai-spend-in-table.md) - [Send options as a dropdown menu](https://botpress-charmenta-pr-696.mintlify.site/studio/guides/how-to/dropdown-menus.md) - [Using code in Studio](https://botpress-charmenta-pr-696.mintlify.site/studio/guides/advanced/use-code.md) - [Event Properties](https://botpress-charmenta-pr-696.mintlify.site/studio/guides/advanced/event-properties.md) - [State Management](https://botpress-charmenta-pr-696.mintlify.site/studio/guides/advanced/best-practices-for-state-management.md): Manage the 128 KB state size limit in Botpress by optimizing Workflows, clearing unused variables, and minimizing large data usage. - [Safety](https://botpress-charmenta-pr-696.mintlify.site/studio/guides/advanced/safety/introduction.md): Botpress provides a robust feature set that ensure AI-driven interactions are safe, controlled, and compliant. - [Preventing Abuse](https://botpress-charmenta-pr-696.mintlify.site/studio/guides/advanced/safety/preventing-abuse.md) - [Brand Safety Framework](https://botpress-charmenta-pr-696.mintlify.site/studio/guides/advanced/safety/brand-safety-framework.md): Control AI responses, enforce brand-aligned messaging, and prevent harmful outputs. - [Exporting Data](https://botpress-charmenta-pr-696.mintlify.site/studio/guides/advanced/exporting-data/introduction.md): Export data from your bot using the Botpress API by requesting the relevant endpoint. - [Raw Conversations](https://botpress-charmenta-pr-696.mintlify.site/studio/guides/advanced/exporting-data/exporting-raw-conversations-with-the-botpress-api.md) - [Conversation History](https://botpress-charmenta-pr-696.mintlify.site/studio/guides/advanced/exporting-data/getting-the-conversation-history-from-within-your-bot.md) - [Streaming Analytics](https://botpress-charmenta-pr-696.mintlify.site/studio/guides/advanced/exporting-data/streaming-analytics-from-within-your-bot-with-hooks.md) - [Compiled Bot Analytics](https://botpress-charmenta-pr-696.mintlify.site/studio/guides/advanced/exporting-data/exporting-compiled-bot-analytics-with-the-botpress-api.md) - [Accessing The Autonomous Nodes Thought Process](https://botpress-charmenta-pr-696.mintlify.site/studio/guides/advanced/exporting-data/analyze-llmz-responses.md): Analyze Knowledge Base responses from Autonomous Nodes in Botpress with the “After LLMz Execution” hook. - [Advanced Starter Template](https://botpress-charmenta-pr-696.mintlify.site/studio/guides/advanced/kitchen-sink-advanced-starter-template.md) - [Tips to optimize AI Cost](https://botpress-charmenta-pr-696.mintlify.site/studio/guides/advanced/tips-to-optimize-ai-cost.md) - [Retention Period](https://botpress-charmenta-pr-696.mintlify.site/studio/guides/advanced/retention-period.md) - [Botpress v12 (and self-hosted versions)](https://botpress-charmenta-pr-696.mintlify.site/studio/guides/advanced/v12.md) - [Introduction to integrations](https://botpress-charmenta-pr-696.mintlify.site/integrations/get-started/introduction.md): Connect your bot to external services. - [Botpress Hub](https://botpress-charmenta-pr-696.mintlify.site/integrations/get-started/botpress-hub.md): Marketplace to find and install integrations. - [Apify (Advanced Website Crawler)](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/plus-apify.md): Add a bot to Apify using the official integration. - [Apollo](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/apollo.md): Add a bot to Apollo using the official integration. - [Attio](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/attio.md): Add a bot to Attio using the official integration. - [Asana](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/asana.md) - [BambooHR](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/bamboohr.md): Add a bot to BambooHR using the official integration. - [Canny](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/canny.md): Add a bot to Canny using the official integration. - [Chat](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/chat.md) - [Chatwoot](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/chatwoot.md): Add a bot to Chatwoot using the official integration. - [Discord](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/discord.md): Add your bot to Discord using the official integration. - [Email Notifier](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/plus-email-notifier.md): Send emails from your bot. - [GitHub](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/github.md): Add a bot to GitHub using the official integration. - [Gmail](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/gmail.md) - [Google Analytics](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/plus-google-analytics.md): Add a bot to Google Analytics using the official integration. - [Google Calendar](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/googlecalendar.md): Add a bot to Google Calendar using the official integration. - [Google Sheets](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/gsheets.md): Add a bot to Google Sheets using the official integration. - [Human-in-the-Loop (HITL)](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/hitl/introduction.md): Allow a live agent to participate directly in the bot's conversation. - [Measure HITL Response Time](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/hitl/time-to-first-agent-response.md): Measure the Time to First Agent Response for conversations in HITL. - [HubSpot](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/hubspot.md): Add a bot to HubSpot using the official integration. - [Hunter](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/hunter.md): Add a bot to Hunter using the official integration. - [Improvement](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/improvement.md) - [Instagram](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/instagram.md): Add your bot to Instagram using the official integration. - [Intercom](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/intercom.md) - [Klaviyo](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/klaviyo.md): Add a bot to Klaviyo using the official integration. - [Knowledge Base Optimizer](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/knowledge-base-optimization.md) - [Kommo](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/kommo.md): Connect your bot to Kommo CRM using the official integration. - [Line](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/line.md) - [Linear](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/linear.md): Connect your bot to Linear using the official integration. - [LinkedIn](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/linkedin.md): Add a bot to LinkedIn using the official integration. - [Loops](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/loops.md): Add a bot to Loops using the official integration. - [MailerLite](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/mailerlite.md): Add a bot to MailerLite using the official integration. - [Messenger and Facebook](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/messenger.md): Add your bot to Messenger and Facebook using the official integration - [Mintlify](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/mintlify.md): Add a bot to Mintlify using the official integration. - [Persat](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/plus-persat.md): Add a bot to Persat using the official integration. - [Microsoft Teams](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/teams.md): Add your bot to Teams using the official integration. - [Notion](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/notion.md): Add a bot to Notion using the official integration. - [Pipedrive](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/pipedrive.md): Add a bot to Pipedrive using the official integration. - [Slack](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/slack.md): Add a bot to Slack using the official integration. - [Sunshine Conversations](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/sunshine-conversations/introduction.md) - [Zendesk Messaging](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/sunshine-conversations/zendesk-messaging.md) - [Telegram](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/telegram.md): Add your bot to Telegram using the official integration. - [Trello](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/trello.md) - [Twilio](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/twilio.md) - [Viber](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/viber.md) - [Vonage](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/vonage.md) - [Webhook](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/webhook.md): Integrate Botpress with other services using a webhook. - [Workable](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/workable.md): Add a bot to Workable using the official integration. - [WhatsApp Setup](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/whatsapp/introduction.md): Add a bot to WhatsApp using the official integration. - [Mapping from Botpress to WhatsApp](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/whatsapp/mapping/botpress-to-whatsapp.md): Content mapping for the official WhatsApp integration. - [Mapping from WhatsApp to Botpress](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/whatsapp/mapping/whatsapp-to-botpress.md): Content mapping for the official WhatsApp integration. - [Start a WhatsApp conversation proactively](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/whatsapp/whatsapp-start-proactively.md): Proactively start a WhatsApp conversation with a specific user. - [Start a conversation on WhatsApp through a webhook](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/whatsapp/start-conversation-through-webhook.md): Trigger a new WhatsApp conversation from an external system using the Webhook integration and the Start Conversation Card. - [Zapier](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/zapier.md) - [Zendesk](https://botpress-charmenta-pr-696.mintlify.site/integrations/integration-guides/zendesk.md): Integrate your bot with Zendesk using the official integration. - [Overview](https://botpress-charmenta-pr-696.mintlify.site/integrations/sdk/overview.md) - [Installation](https://botpress-charmenta-pr-696.mintlify.site/integrations/sdk/installation.md) - [Get started](https://botpress-charmenta-pr-696.mintlify.site/integrations/sdk/integration/getting-started.md): Build your first integration with Botpress. - [Integration for Messaging Channels](https://botpress-charmenta-pr-696.mintlify.site/integrations/sdk/integration/messaging.md) - [Integrations Concepts](https://botpress-charmenta-pr-696.mintlify.site/integrations/sdk/integration/concepts.md) - [Publish your integration on Botpress Hub](https://botpress-charmenta-pr-696.mintlify.site/integrations/sdk/integration/publish-your-integration-on-botpress-hub.md) - [Enable OAuth](https://botpress-charmenta-pr-696.mintlify.site/integrations/sdk/integration/enable-oauth.md) - [Use your own LLM](https://botpress-charmenta-pr-696.mintlify.site/integrations/sdk/integration/use-your-own-llm.md) - [Introduction to interfaces](https://botpress-charmenta-pr-696.mintlify.site/integrations/sdk/interface/introduction.md) - [How to implement an interface in your integration](https://botpress-charmenta-pr-696.mintlify.site/integrations/sdk/interface/how-tos/add-and-implement.md) - [Implementing Human in the loop (HITL) in an integration](https://botpress-charmenta-pr-696.mintlify.site/integrations/sdk/interface/how-tos/implementing-hitl.md) - [Implementing unidirectional file synchronization in an integration](https://botpress-charmenta-pr-696.mintlify.site/integrations/sdk/interface/how-tos/implementing-file-sync.md) - [Bots-as-code](https://botpress-charmenta-pr-696.mintlify.site/integrations/sdk/bots-as-code.md) - [CLI reference](https://botpress-charmenta-pr-696.mintlify.site/integrations/sdk/cli-reference.md): All commands and flags available with the Botpress CLI. - [Introduction to Webchat](https://botpress-charmenta-pr-696.mintlify.site/webchat/get-started/introduction.md): Integrate your bot into your website. - [Quickstart](https://botpress-charmenta-pr-696.mintlify.site/webchat/get-started/quick-start.md): Use the Webchat embed code to add a bot to your website. - [Embed Webchat in an element](https://botpress-charmenta-pr-696.mintlify.site/webchat/get-started/embed-in-element.md) - [Configure Webchat](https://botpress-charmenta-pr-696.mintlify.site/webchat/get-started/configure-your-webchat.md) - [Open/close your Webchat](https://botpress-charmenta-pr-696.mintlify.site/webchat/interact/open-close-webchat.md): Manually open or close Webchat on your website. - [Use custom toggle to open/close Webchat](https://botpress-charmenta-pr-696.mintlify.site/webchat/interact/use-custom-toggle.md) - [Display proactive bubble](https://botpress-charmenta-pr-696.mintlify.site/webchat/interact/proactive-message-bubble.md) - [Automatically open Webchat on page load](https://botpress-charmenta-pr-696.mintlify.site/webchat/interact/open-webchat-on-page-load.md) - [Send user data](https://botpress-charmenta-pr-696.mintlify.site/webchat/interact/send-user-data.md): Provide your bot with data about the current user. - [Listen to events](https://botpress-charmenta-pr-696.mintlify.site/webchat/interact/listen-to-events.md): Listen for when Webchat opens, closes, raises an error, and more. - [Trigger actions when conversation starts](https://botpress-charmenta-pr-696.mintlify.site/webchat/interact/start-trigger.md) - [Display notification bubble](https://botpress-charmenta-pr-696.mintlify.site/webchat/interact/webchat-notification.md) - [Send a message from user](https://botpress-charmenta-pr-696.mintlify.site/webchat/interact/send-message.md) - [Send custom events from Webchat to your website](https://botpress-charmenta-pr-696.mintlify.site/webchat/interact/send-custom-events/from-webchat.md): Let your website know when something happens in your user's conversation. - [Send custom events from your website to Webchat](https://botpress-charmenta-pr-696.mintlify.site/webchat/interact/send-custom-events/to-webchat.md) - [Update Webchat configuration](https://botpress-charmenta-pr-696.mintlify.site/webchat/interact/update-config.md) - [Error handling](https://botpress-charmenta-pr-696.mintlify.site/webchat/interact/error-handling.md) - [Webchat methods reference](https://botpress-charmenta-pr-696.mintlify.site/webchat/interact/reference.md) - [WordPress](https://botpress-charmenta-pr-696.mintlify.site/webchat/integrations/wordpress.md): Add a bot to your WordPress website using Webchat. - [Wix](https://botpress-charmenta-pr-696.mintlify.site/webchat/integrations/wix.md): Add a bot to your Wix website using Webchat. - [Webflow](https://botpress-charmenta-pr-696.mintlify.site/webchat/integrations/webflow.md): Add a bot to your Webflow website using Webchat. - [React Native](https://botpress-charmenta-pr-696.mintlify.site/webchat/integrations/react-native.md): Add your bot in any React Native or Expo app using react-native-webview. - [Get started](https://botpress-charmenta-pr-696.mintlify.site/webchat/react-library/get-started.md): Install the Webchat React library and build your first component. - [Webchat](https://botpress-charmenta-pr-696.mintlify.site/webchat/react-library/components/webchat.md) - [Floating Action Button](https://botpress-charmenta-pr-696.mintlify.site/webchat/react-library/components/fab.md) - [Container](https://botpress-charmenta-pr-696.mintlify.site/webchat/react-library/components/container.md) - [Header](https://botpress-charmenta-pr-696.mintlify.site/webchat/react-library/components/header.md) - [MessageList](https://botpress-charmenta-pr-696.mintlify.site/webchat/react-library/components/message-list.md) - [Composer](https://botpress-charmenta-pr-696.mintlify.site/webchat/react-library/components/composer.md) - [StylesheetProvider](https://botpress-charmenta-pr-696.mintlify.site/webchat/react-library/components/stylesheet-provider.md) - [useWebchat](https://botpress-charmenta-pr-696.mintlify.site/webchat/react-library/hooks/use-webchat-client.md) - [Introduction to Botpress Desk](https://botpress-charmenta-pr-696.mintlify.site/desk/introduction.md) - [Introduction to the ADK](https://botpress-charmenta-pr-696.mintlify.site/adk/introduction.md): TypeScript framework for building AI agents on Botpress. - [Quickstart](https://botpress-charmenta-pr-696.mintlify.site/adk/quickstart.md): Install the ADK and create your first agent project. - [Configuration](https://botpress-charmenta-pr-696.mintlify.site/adk/setup/configuration.md): Understand your project structure and how to configure your agent. - [Environment setup](https://botpress-charmenta-pr-696.mintlify.site/adk/setup/environment.md): Manage secrets, configuration values, and development/production environments. - [Integrations](https://botpress-charmenta-pr-696.mintlify.site/adk/setup/integrations.md): Connect your agent to channels and external services. - [Set up conversations](https://botpress-charmenta-pr-696.mintlify.site/adk/conversations/setup.md): Handle user messages across channels. - [Run AI agents in a conversation](https://botpress-charmenta-pr-696.mintlify.site/adk/conversations/ai-execution.md): Use `execute()` to hand messages to the AI model. - [Define tools](https://botpress-charmenta-pr-696.mintlify.site/adk/conversations/tools.md): Give the AI model functions it can call during execution. - [Send messages and content](https://botpress-charmenta-pr-696.mintlify.site/adk/conversations/messages.md): Send text, images, cards, carousels, and more from your handler. - [Use custom components](https://botpress-charmenta-pr-696.mintlify.site/adk/conversations/custom-components.md): Build and render custom React UI inside Webchat. - [Manage conversation lifecycle](https://botpress-charmenta-pr-696.mintlify.site/adk/conversations/lifecycle.md): Configure nudges, expiration, and session management for conversations. - [Manage state](https://botpress-charmenta-pr-696.mintlify.site/adk/conversations/state.md): Store and reuse data across conversations, users, and the entire bot. - [Create workflows](https://botpress-charmenta-pr-696.mintlify.site/adk/workflows/create.md): Build long-running background processes that run independently of conversations. - [Use workflow steps](https://botpress-charmenta-pr-696.mintlify.site/adk/workflows/steps.md): Break workflows into persisted, resumable checkpoints. - [Request and notify from workflows](https://botpress-charmenta-pr-696.mintlify.site/adk/workflows/request-notify.md): Exchange data between workflows and conversations. - [Create actions](https://botpress-charmenta-pr-696.mintlify.site/adk/external/actions.md): Create reusable functions that can be called from anywhere in your agent or from external systems. - [Set up triggers](https://botpress-charmenta-pr-696.mintlify.site/adk/external/triggers.md): React to events from integrations and custom events. - [Tables](https://botpress-charmenta-pr-696.mintlify.site/adk/data/tables.md): Define and query structured data storage. - [Knowledge bases](https://botpress-charmenta-pr-696.mintlify.site/adk/data/knowledge.md): Give your agent access to documents, websites, and files. - [Write and run evals](https://botpress-charmenta-pr-696.mintlify.site/adk/testing/evals.md): Automated conversation tests for your agent. - [Agent steps](https://botpress-charmenta-pr-696.mintlify.site/adk/testing/agent-steps.md): See what your agent did during each conversation turn in real time. - [Debug with logs and traces](https://botpress-charmenta-pr-696.mintlify.site/adk/testing/debugging.md): Inspect traces, spans, and logs to understand what your agent is doing. - [Run scripts](https://botpress-charmenta-pr-696.mintlify.site/adk/testing/scripts.md): Execute TypeScript scripts with full access to your agent's runtime context. - [Introduction to Zai](https://botpress-charmenta-pr-696.mintlify.site/adk/zai/overview.md): Type-safe LLM utilities for common AI operations. - [Extract structured data](https://botpress-charmenta-pr-696.mintlify.site/adk/zai/extract.md): Pull typed data from unstructured text using an LLM. - [Generate text and summaries](https://botpress-charmenta-pr-696.mintlify.site/adk/zai/generate.md): Generate, rewrite, summarize, and answer questions with citations. - [Classify, validate and filter](https://botpress-charmenta-pr-696.mintlify.site/adk/zai/classify.md): Check conditions, label content, filter, sort, rate, and group items. - [Skills](https://botpress-charmenta-pr-696.mintlify.site/adk/ai-native/skills.md): Give AI coding assistants deep ADK knowledge with installable skills. - [Human-in-the-loop (HITL)](https://botpress-charmenta-pr-696.mintlify.site/adk/advanced/hitl.md): Escalate conversations to live human agents. - [HITL with Desk](https://botpress-charmenta-pr-696.mintlify.site/adk/advanced/desk-hitl.md): Escalate conversations to support agents in Botpress Desk. - [CLI reference](https://botpress-charmenta-pr-696.mintlify.site/adk/cli-reference.md): All commands and flags available with the ADK CLI. - [Introduction](https://botpress-charmenta-pr-696.mintlify.site/tutorial/introduction.md) - [Prompting](https://botpress-charmenta-pr-696.mintlify.site/tutorial/basics/first-steps/prompting.md) - [Adding knowledge](https://botpress-charmenta-pr-696.mintlify.site/tutorial/basics/first-steps/adding-knowledge.md) - [Workflows](https://botpress-charmenta-pr-696.mintlify.site/tutorial/basics/custom-logic/workflows.md) - [Creating Nodes](https://botpress-charmenta-pr-696.mintlify.site/tutorial/basics/custom-logic/creating-nodes.md) - [Adding Cards](https://botpress-charmenta-pr-696.mintlify.site/tutorial/basics/custom-logic/adding-cards.md) - [Using custom logic with AI](https://botpress-charmenta-pr-696.mintlify.site/tutorial/basics/custom-logic/using-custom-logic-with-ai.md) - [Variables](https://botpress-charmenta-pr-696.mintlify.site/tutorial/basics/storing-information/variables.md) - [Assigning a value](https://botpress-charmenta-pr-696.mintlify.site/tutorial/basics/storing-information/assigning-a-value.md) - [Scoping variables](https://botpress-charmenta-pr-696.mintlify.site/tutorial/basics/storing-information/scoping-variables.md) - [Introduction](https://botpress-charmenta-pr-696.mintlify.site/api-reference/introduction.md) - [Authentication](https://botpress-charmenta-pr-696.mintlify.site/api-reference/authentication.md) - [Pagination](https://botpress-charmenta-pr-696.mintlify.site/api-reference/pagination.md) - [Rate limiting](https://botpress-charmenta-pr-696.mintlify.site/api-reference/ratelimiting.md) - [Errors](https://botpress-charmenta-pr-696.mintlify.site/api-reference/errors.md) - [Chat API Introduction](https://botpress-charmenta-pr-696.mintlify.site/api-reference/chat-api/introduction.md) - [getConversation](https://botpress-charmenta-pr-696.mintlify.site/api-reference/chat-api/openapi/getConversation.md): Retrieves the [Conversation](#schema_conversation) object for a valid identifier. - [deleteConversation](https://botpress-charmenta-pr-696.mintlify.site/api-reference/chat-api/openapi/deleteConversation.md): Permanently deletes a [Conversation](#schema_conversation). It cannot be undone. Also immediately deletes corresponding [Messages](#schema_message). - [createConversation](https://botpress-charmenta-pr-696.mintlify.site/api-reference/chat-api/openapi/createConversation.md): Creates a new [Conversation](#schema_conversation) - [listConversations](https://botpress-charmenta-pr-696.mintlify.site/api-reference/chat-api/openapi/listConversations.md): Returns a list of [Conversation](#schema_conversation) objects - [getOrCreateConversation](https://botpress-charmenta-pr-696.mintlify.site/api-reference/chat-api/openapi/getOrCreateConversation.md): Get or create a new [Conversation](#schema_conversation) - [listenConversation](https://botpress-charmenta-pr-696.mintlify.site/api-reference/chat-api/openapi/listenConversation.md): Creates a SSE stream to receive messages and events from a conversation - [listMessages](https://botpress-charmenta-pr-696.mintlify.site/api-reference/chat-api/openapi/listMessages.md): Retrieves the conversation's [Messages](#schema_message) - [getMessage](https://botpress-charmenta-pr-696.mintlify.site/api-reference/chat-api/openapi/getMessage.md): Retrieves the [Message](#schema_message) object for a valid identifier. - [deleteMessage](https://botpress-charmenta-pr-696.mintlify.site/api-reference/chat-api/openapi/deleteMessage.md): Permanently deletes a [Message](#schema_message). It cannot be undone. - [createMessage](https://botpress-charmenta-pr-696.mintlify.site/api-reference/chat-api/openapi/createMessage.md): Creates a new [Message](#schema_message) - [addParticipant](https://botpress-charmenta-pr-696.mintlify.site/api-reference/chat-api/openapi/addParticipant.md): Add a [Participant](#schema_user) to a [Conversation](#schema_conversation). - [listParticipants](https://botpress-charmenta-pr-696.mintlify.site/api-reference/chat-api/openapi/listParticipants.md): Retrieves a list of [Participants](#schema_user) for a given [Conversation](#schema_conversation). - [removeParticipant](https://botpress-charmenta-pr-696.mintlify.site/api-reference/chat-api/openapi/removeParticipant.md): Remove a [Participant](#schema_user) from a [Conversation](#schema_conversation). - [getParticipant](https://botpress-charmenta-pr-696.mintlify.site/api-reference/chat-api/openapi/getParticipant.md): Retrieves a [Participant](#schema_user) from a [Conversation](#schema_conversation). - [getUser](https://botpress-charmenta-pr-696.mintlify.site/api-reference/chat-api/openapi/getUser.md): Retrieves the [User](#schema_user) object for a valid identifier. - [updateUser](https://botpress-charmenta-pr-696.mintlify.site/api-reference/chat-api/openapi/updateUser.md): Update [User](#schema_user) - [deleteUser](https://botpress-charmenta-pr-696.mintlify.site/api-reference/chat-api/openapi/deleteUser.md): Permanently deletes a [User](#schema_user). It cannot be undone. - [createUser](https://botpress-charmenta-pr-696.mintlify.site/api-reference/chat-api/openapi/createUser.md): Creates a new [User](#schema_user). This operation can only be called when using the shared encryption key. - [getOrCreateUser](https://botpress-charmenta-pr-696.mintlify.site/api-reference/chat-api/openapi/getOrCreateUser.md): Get or create a new [User](#schema_user) - [getEvent](https://botpress-charmenta-pr-696.mintlify.site/api-reference/chat-api/openapi/getEvent.md): Retrieves the [Event](#schema_event) object for a valid identifier. - [createEvent](https://botpress-charmenta-pr-696.mintlify.site/api-reference/chat-api/openapi/createEvent.md): Creates a custom [Event](#schema_event) - [Getting started](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/getting-started.md) - [Concepts](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/concepts.md) - [getAccount](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/get-v1adminaccountme.md): Get details of the account authenticating with this endpoint. - [updateAccount](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/put-v1adminaccountme.md): Update details of the account associated with authenticated user - [listPublicIntegrations](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/get-v1adminhubintegrations.md): List public integration - [getPublicIntegrationById](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/get-v1adminhubintegrations-1.md): Get public integration by Id - [getPublicIntegration](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/get-v1adminhubintegrations-.md): Get public integration by name and version - [listBots](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/get-v1adminbots.md): List bots - [createBot](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/post-v1adminbots.md): Create bot - [getBot](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/get-v1adminbots-1.md): Get bot details - [updateBot](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/put-v1adminbots.md): Update bot - [deleteBot](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/delete-v1adminbots.md): Delete bot - [getBotLogs](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/get-v1adminbots-logs.md): Get bot logs - [getBotAnalytics](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/get-v1adminbots-analytics.md): Get bot analytics - [getBotIssue](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/get-v1adminbots-issues.md): Get Bot Issue - [deleteBotIssue](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/delete-v1adminbots-issues.md): Delete Bot Issue - [listBotIssues](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/get-v1adminbots-issues-1.md): List Bot Issues - [listBotIssueEvents](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/get-v1adminbots-issues-events.md): List Events for a Bot Issue - [listWorkspaces](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/get-v1adminworkspaces.md): List workspaces the user has access to - [createWorkspace](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/post-v1adminworkspaces.md): Create workspace - [getPublicWorkspace](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/get-v1adminworkspaces-public.md): Get workspace public details - [getWorkspace](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/get-v1adminworkspaces-1.md): Get workspace details - [updateWorkspace](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/put-v1adminworkspaces.md): Update workspace - [deleteWorkspace](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/delete-v1adminworkspaces.md): Delete workspace - [listPublicWorkspaces](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/get-v1adminworkspacespublic.md): List public workspaces - [getAuditRecords](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/get-v1adminworkspaces-audit-records.md): Get the audit records of a workspace, sorted from most recent to oldest. - [listWorkspaceMembers](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/get-v1adminworkspace-members.md): Lists all the members in a workspace - [createWorkspaceMember](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/post-v1adminworkspace-members.md): Add a member to the workspace - [getWorkspaceMember](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/get-v1adminworkspace-membersme.md): Get details of the account authenticating with this endpoint. - [updateWorkspaceMember](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/put-v1adminworkspace-members.md): Update the member of a workspace - [deleteWorkspaceMember](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/delete-v1adminworkspace-members.md): Remove a member of a workspace - [listIntegrations](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/get-v1adminintegrations.md): List integrations, supports filtering and sorting capabilities - [createIntegration](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/post-v1adminintegrations.md): Create integration - [validateIntegrationCreation](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/post-v1adminintegrationsvalidate.md): Perform a validation of an integration creation request - [getIntegration](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/get-v1adminintegrations-1.md): Get integration - [updateIntegration](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/put-v1adminintegrations.md): Update integration - [deleteIntegration](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/delete-v1adminintegrations.md): Delete integration - [validateIntegrationUpdate](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/put-v1adminintegrations-validate.md): Perform a validation of an integration update request - [getIntegrationLogs](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/get-v1adminintegrations-logs.md): Get integration logs - [getIntegrationByName](https://botpress-charmenta-pr-696.mintlify.site/api-reference/admin-api/openapi/endpoints/get-v1adminintegrations-.md): Get integration - [Getting started](https://botpress-charmenta-pr-696.mintlify.site/api-reference/files-api/getting-started.md) - [Create files](https://botpress-charmenta-pr-696.mintlify.site/api-reference/files-api/how-tos/creating-files.md) - [Index and search files](https://botpress-charmenta-pr-696.mintlify.site/api-reference/files-api/how-tos/index-and-search-files.md) - [Manage files](https://botpress-charmenta-pr-696.mintlify.site/api-reference/files-api/how-tos/manage-files.md) - [listFiles](https://botpress-charmenta-pr-696.mintlify.site/api-reference/files-api/openapi/endpoints/get-v1files.md): List files for bot - [upsertFile](https://botpress-charmenta-pr-696.mintlify.site/api-reference/files-api/openapi/endpoints/put-v1files.md): Creates or updates a file using the `key` parameter as unique identifier. Updating a file will erase the existing content of the file. Upload the file content by sending it in a PUT request to the `uploadUrl` returned in the response. - [getFile](https://botpress-charmenta-pr-696.mintlify.site/api-reference/files-api/openapi/endpoints/get-v1files-1.md): Get file - [updateFileMetadata](https://botpress-charmenta-pr-696.mintlify.site/api-reference/files-api/openapi/endpoints/put-v1files-1.md): Update file metadata, without updating the file content. - [deleteFile](https://botpress-charmenta-pr-696.mintlify.site/api-reference/files-api/openapi/endpoints/delete-v1files.md): Deletes a file. - [copyFile](https://botpress-charmenta-pr-696.mintlify.site/api-reference/files-api/openapi/endpoints/post-v1files-.md): Copy file - [searchFiles](https://botpress-charmenta-pr-696.mintlify.site/api-reference/files-api/openapi/endpoints/get-v1filessearch.md): Search files - [listFilePassages](https://botpress-charmenta-pr-696.mintlify.site/api-reference/files-api/openapi/endpoints/get-v1files-passages.md): List passages for a file - [listFileTags](https://botpress-charmenta-pr-696.mintlify.site/api-reference/files-api/openapi/endpoints/get-v1filestags.md): List available tags - [listFileTagValues](https://botpress-charmenta-pr-696.mintlify.site/api-reference/files-api/openapi/endpoints/get-v1filestags-values.md): List available tags - [Getting Started](https://botpress-charmenta-pr-696.mintlify.site/api-reference/tables-api/getting-started.md) - [listTables](https://botpress-charmenta-pr-696.mintlify.site/api-reference/tables-api/openapi/endpoints/get-v1tables.md): Retrieves a list of all tables associated with your bot. - [createTable](https://botpress-charmenta-pr-696.mintlify.site/api-reference/tables-api/openapi/endpoints/post-v1tables.md): Initiates the creation of a new table based on the provided schema, excluding system-managed fields like IDs and timestamps. - [getTable](https://botpress-charmenta-pr-696.mintlify.site/api-reference/tables-api/openapi/endpoints/get-v1tables-1.md): Retrieves detailed information about a specific table, identified by its name or unique identifier. - [updateTable](https://botpress-charmenta-pr-696.mintlify.site/api-reference/tables-api/openapi/endpoints/put-v1tables.md): Updates the schema or the name of an existing table. - [getOrCreateTable](https://botpress-charmenta-pr-696.mintlify.site/api-reference/tables-api/openapi/endpoints/post-v1tables-1.md): Retrieves information about a specific table if it exists; otherwise, creates a new table based on the provided schema. - [deleteTable](https://botpress-charmenta-pr-696.mintlify.site/api-reference/tables-api/openapi/endpoints/delete-v1tables.md): Permanently deletes a table and all its associated data from the system. Use with caution, as this action cannot be undone. - [duplicateTable](https://botpress-charmenta-pr-696.mintlify.site/api-reference/tables-api/openapi/endpoints/post-v1tables-duplicate.md): Duplicates the table schema & content - [renameTableColumn](https://botpress-charmenta-pr-696.mintlify.site/api-reference/tables-api/openapi/endpoints/put-v1tables-column.md): Renames an existing column within a table to better reflect its content or usage. The operation targets a specific table and requires the current and new column names. - [getTableRow](https://botpress-charmenta-pr-696.mintlify.site/api-reference/tables-api/openapi/endpoints/get-v1tables-row.md): Fetches a specific row from a table using the row's unique identifier. - [findTableRows](https://botpress-charmenta-pr-696.mintlify.site/api-reference/tables-api/openapi/endpoints/post-v1tables-rowsfind.md): Enables the search and filtering of rows within a table based on specific criteria. This operation supports complex queries for advanced data manipulation and retrieval. - [updateTableRows](https://botpress-charmenta-pr-696.mintlify.site/api-reference/tables-api/openapi/endpoints/put-v1tables-rows.md): Updates specified rows in a table, allowing partial success with detailed feedback on errors. - [createTableRows](https://botpress-charmenta-pr-696.mintlify.site/api-reference/tables-api/openapi/endpoints/post-v1tables-rows.md): Inserts one or multiple new rows into the specified table. - [deleteTableRows](https://botpress-charmenta-pr-696.mintlify.site/api-reference/tables-api/openapi/endpoints/post-v1tables-rowsdelete.md): Allows selective deletion of rows or complete clearance of a table. - [upsertTableRows](https://botpress-charmenta-pr-696.mintlify.site/api-reference/tables-api/openapi/endpoints/post-v1tables-rowsupsert.md): Inserts or updates rows based on a key. If a row exists, it is updated; otherwise, a new row is created. - [Getting Started](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/getting-started.md) - [Concepts](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/concepts.md) - [listConversations](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/get-v1chatconversations.md): Retrieves a list of [Conversation](#schema_conversation) you’ve previously created. The conversations are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags). - [createConversation](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/post-v1chatconversations.md): Creates a new [Conversation](#schema_conversation). When creating a new [Conversation](#schema_conversation), the required tags must be provided. See the specific integration for more details. - [getConversation](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/get-v1chatconversations-1.md): Retrieves the [Conversation](#schema_conversation) object for a valid identifier. - [updateConversation](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/put-v1chatconversations.md): Update a [Conversation](#schema_conversation) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [deleteConversation](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/delete-v1chatconversations.md): Permanently deletes a [Conversation](#schema_conversation). It cannot be undone. Also immediately deletes corresponding [Messages](#schema_message). - [getOrCreateConversation](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/post-v1chatconversationsget-or-create.md): Retrieves the [Conversation](#schema_conversation) object containing given tags. If the conversation does not exist, it will be created. Tags will be updated if they are set in the request body. - [listParticipants](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/get-v1chatconversations-participants.md): Retrieves a list of [Participant](#schema_participant) for a given [Conversation](#schema_conversation). - [addParticipant](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/post-v1chatconversations-participants.md): Add a [Participant](#schema_participant) to a [Conversation](#schema_conversation). - [getParticipant](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/get-v1chatconversations-participants-1.md): Retrieves a [Participant](#schema_participant) from a [Conversation](#schema_conversation). - [removeParticipant](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/delete-v1chatconversations-participants.md): Remove a [Participant](#schema_participant) from a [Conversation](#schema_conversation). - [listEvents](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/get-v1chatevents.md): Retrieves a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first. - [createEvent](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/post-v1chatevents.md): Creates a new [Event](#schema_event). When creating a new [Event](#schema_event), the required tags must be provided. See the specific integration for more details. - [getEvent](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/get-v1chatevents-1.md): Retrieves the [Event](#schema_event) object for a valid identifiers. - [cancelScheduledEvent](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/delete-v1chateventsscheduled.md): Permanently cancels a scheduled [Event](#schema_event). The event must be in a `scheduled` state. - [listMessages](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/get-v1chatmessages.md): Retrieves a list of [Message](#schema_message) you’ve previously created. The messages are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](/docs/developers/concepts/tags). - [createMessage](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/post-v1chatmessages.md): Creates a new [Message](#schema_message). When creating a new [Message](#schema_message), the required tags must be provided. See the specific integration for more details. - [getOrCreateMessage](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/post-v1chatmessagesget-or-create.md): Retrieves the [Message](#schema_message) object for given discriminating tags. If the message does not exist, it will be created. If the message already exists, its tags and payload will be updated with the provided values if they are defined. - [getMessage](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/get-v1chatmessages-1.md): Retrieves the [Message](#schema_message) object for a valid identifier. - [updateMessage](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/put-v1chatmessages.md): Updates a message tags and payload. The message type cannot be changed. Calling this operation from an integration, to update an incoming message, will not invoke the bot. The other way around it also true; Calling this operation from the bot, to update an outgoing message, will not invoke the integ… - [deleteMessage](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/delete-v1chatmessages.md): Permanently deletes a [Message](#schema_message). It cannot be undone. - [listUsers](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/get-v1chatusers.md): Retrieves a list of [User](#schema_user) previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](/docs/developers/concepts/tags). - [createUser](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/post-v1chatusers.md): Creates a new [User](#schema_user). When creating a new [User](#schema_user), the required tags must be provided. See the specific integration for more details. - [getUser](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/get-v1chatusers-1.md): Retrieves the [User](#schema_user) object for a valid identifier. - [updateUser](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/put-v1chatusers.md): Update a [User](#schema_user) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [deleteUser](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/delete-v1chatusers.md): Permanently deletes a [User](#schema_user). It cannot be undone. - [getOrCreateUser](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/post-v1chatusersget-or-create.md): Retrieves the [User](#schema_user) object for given discriminating tags. If the user does not exist, it will be created. If the user already exists, its name, pictureUrl, attributes, and tags will be updated with the provided values. - [setStateExpiry](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/post-v1chatstates--expiry.md): Updates the [State](#schema_state) expiry. - [getState](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/get-v1chatstates-.md): Retrieves the [State](#schema_state) object for a valid identifiers. - [setState](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/post-v1chatstates-.md): Overrides the [State](#schema_state) object by setting the values of the parameters passed. - [patchState](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/patch-v1chatstates-.md): Updates the [State](#schema_state) object by setting the values of the parameters passed. - [getOrSetState](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/post-v1chatstates--get-or-set.md): Retrieves the [State](#schema_state) object for a valid identifiers. If the state does not exist, it creates a new state. - [callAction](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/post-v1chatactions.md): Call an action - [configureIntegration](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/post-v1chatintegrationsconfigure.md): An integration can call this endpoint to configure itself - [listTagValues](https://botpress-charmenta-pr-696.mintlify.site/api-reference/runtime-api/openapi/endpoints/get-v1chattags-values.md): Get a bot tag values - [Changelog](https://botpress-charmenta-pr-696.mintlify.site/changelog.md): The latest updates and improvements to Botpress. ## OpenAPI Specs - [tables-openapi](https://botpress-charmenta-pr-696.mintlify.site/tables-openapi.json) - [runtime-openapi](https://botpress-charmenta-pr-696.mintlify.site/runtime-openapi.json) - [files-openapi](https://botpress-charmenta-pr-696.mintlify.site/files-openapi.json) - [chat-openapi](https://botpress-charmenta-pr-696.mintlify.site/chat-openapi.json) - [admin-openapi](https://botpress-charmenta-pr-696.mintlify.site/admin-openapi.json) ## Optional - [Community Discord](https://discord.com/invite/botpress) - [News & Resources](https://botpress.com/blog) - [Botpress Desk](https://desk.support.channel)