# Botpress Documentation

> Documentation for building AI agents with Botpress.

Full docs available at: https://botpress.com/docs

## Botpress Studio
- [Introduction to Studio](https://botpress.com/docs/docs/studio/introduction.md)
- [Quickstart](https://botpress.com/docs/docs/studio/get-started/quick-start.md)

## Manage your agent
  - [Preview](https://botpress.com/docs/docs/studio/get-started/manage-your-agent/preview.md)
  - [Monitor performance](https://botpress.com/docs/docs/studio/get-started/manage-your-agent/monitor.md)
  - [Add knowledge sources](https://botpress.com/docs/docs/studio/get-started/manage-your-agent/knowledge.md)
  - [Inspect behaviour](https://botpress.com/docs/docs/studio/get-started/manage-your-agent/inspect.md)
  - [Configure Human Handoff](https://botpress.com/docs/docs/studio/get-started/manage-your-agent/human-handoff.md)
  - [Edit appearance](https://botpress.com/docs/docs/studio/get-started/manage-your-agent/edit-appearance.md)
  - [Control access to your agent](https://botpress.com/docs/docs/studio/get-started/manage-your-agent/control-access.md)
- [Configure your workspace](https://botpress.com/docs/docs/studio/get-started/configure-your-workspace.md)

## Concepts
  - [Home](https://botpress.com/docs/docs/studio/concepts/home.md)

### Nodes
    - [Nodes](https://botpress.com/docs/docs/studio/concepts/nodes/introduction.md)
    - [Autonomous Node](https://botpress.com/docs/docs/studio/concepts/nodes/autonomous-node.md)

### Cards
    - [Cards](https://botpress.com/docs/docs/studio/concepts/cards/introduction.md)
    - [Send Messages](https://botpress.com/docs/docs/studio/concepts/cards/send-messages.md)
    - [Execute Code](https://botpress.com/docs/docs/studio/concepts/cards/execute-code.md)
    - [Tables](https://botpress.com/docs/docs/studio/concepts/cards/tables.md)
    - [Set inactivity timeout](https://botpress.com/docs/docs/studio/concepts/cards/set-inactivity-timeout.md)
    - [Webchat](https://botpress.com/docs/docs/studio/concepts/cards/webchat.md)
    - [Flow Logic](https://botpress.com/docs/docs/studio/concepts/cards/flow-logic.md)

#### AI
      - [AI](https://botpress.com/docs/docs/studio/concepts/cards/ai/introduction.md)
      - [AI Task](https://botpress.com/docs/docs/studio/concepts/cards/ai/ai-task.md)
      - [AI Transition](https://botpress.com/docs/docs/studio/concepts/cards/ai/ai-transition.md)
      - [AI Generate Text](https://botpress.com/docs/docs/studio/concepts/cards/ai/ai-generate-text.md)
    - [Capture Information](https://botpress.com/docs/docs/studio/concepts/cards/capture-information.md)
    - [Fixed Schedule](https://botpress.com/docs/docs/studio/concepts/cards/fixed-schedule.md)
    - [Agents](https://botpress.com/docs/docs/studio/concepts/cards/agents.md)
    - [Utilities](https://botpress.com/docs/docs/studio/concepts/cards/utilities.md)
  - [Workflows](https://botpress.com/docs/docs/studio/concepts/workflows.md)

### Knowledge Bases
    - [Knowledge Bases](https://botpress.com/docs/docs/studio/concepts/knowledge-base/introduction.md)
    - [Add sources to Knowledge Base](https://botpress.com/docs/docs/studio/concepts/knowledge-base/add-sources.md)
    - [Knowledge Base Best Practices](https://botpress.com/docs/docs/studio/concepts/knowledge-base/knowledge-base-best-practices.md)
  - [Tables](https://botpress.com/docs/docs/studio/concepts/tables.md)
  - [Actions](https://botpress.com/docs/docs/studio/concepts/actions.md)

### Agents
    - [Agents](https://botpress.com/docs/docs/studio/concepts/agents/introduction.md)
    - [Summary Agent](https://botpress.com/docs/docs/studio/concepts/agents/summary-agent.md)
    - [Personality Agent](https://botpress.com/docs/docs/studio/concepts/agents/personality-agent.md)
    - [Policy Agent](https://botpress.com/docs/docs/studio/concepts/agents/policy-agent.md)
    - [Translator Agent](https://botpress.com/docs/docs/studio/concepts/agents/translator-agent.md)
    - [Knowledge Agent](https://botpress.com/docs/docs/studio/concepts/agents/knowledge-agent.md)
    - [HITL Agent](https://botpress.com/docs/docs/studio/concepts/agents/hitl-agent.md)
    - [Vision Agent](https://botpress.com/docs/docs/studio/concepts/agents/vision-agent.md)
    - [Analytics Agent](https://botpress.com/docs/docs/studio/concepts/agents/analytics-agent.md)
  - [Hooks](https://botpress.com/docs/docs/studio/concepts/hooks.md)
  - [Hub](https://botpress.com/docs/docs/studio/concepts/card-hub.md)
  - [Integrations](https://botpress.com/docs/docs/studio/concepts/integrations.md)
  - [Schemas](https://botpress.com/docs/docs/studio/concepts/schemas.md)
  - [Versions](https://botpress.com/docs/docs/studio/concepts/versions.md)
  - [Bot Settings](https://botpress.com/docs/docs/studio/concepts/bot-settings.md)
  - [Find](https://botpress.com/docs/docs/studio/concepts/find.md)

### Variables
    - [Variables](https://botpress.com/docs/docs/studio/concepts/variables/overview.md)

#### Scopes
      - [Workflow variables](https://botpress.com/docs/docs/studio/concepts/variables/scopes/workflow.md)
      - [User variables](https://botpress.com/docs/docs/studio/concepts/variables/scopes/user.md)
      - [Conversation variables](https://botpress.com/docs/docs/studio/concepts/variables/scopes/conversation.md)
      - [Bot variables](https://botpress.com/docs/docs/studio/concepts/variables/scopes/bot.md)
      - [Configuration variables](https://botpress.com/docs/docs/studio/concepts/variables/scopes/configuration.md)
    - [Built-in variables](https://botpress.com/docs/docs/studio/concepts/variables/built-in.md)
    - [Pass variables between Workflows](https://botpress.com/docs/docs/studio/concepts/variables/pass-between-workflows.md)
    - [Use variables in code](https://botpress.com/docs/docs/studio/concepts/variables/in-code.md)
  - [Triggers](https://botpress.com/docs/docs/studio/concepts/triggers.md)
  - [Debugger, Logs & JSON](https://botpress.com/docs/docs/studio/concepts/debugger-logs-json.md)
  - [Emulator](https://botpress.com/docs/docs/studio/concepts/emulator.md)
  - [Import & Export](https://botpress.com/docs/docs/studio/concepts/import-export-bots.md)
  - [Copy to bot](https://botpress.com/docs/docs/studio/concepts/copy-to-bot.md)

### Controls and Settings
    - [Keyboard Shortcuts](https://botpress.com/docs/docs/studio/concepts/controls-and-settings/keyboard-shortcuts.md)
    - [Commands](https://botpress.com/docs/docs/studio/concepts/controls-and-settings/studio-commands.md)
    - [Studio Preferences](https://botpress.com/docs/docs/studio/concepts/controls-and-settings/studio-preferences.md)

## Guides
  - [Introduction](https://botpress.com/docs/docs/studio/guides/introduction.md)

### How-to
    - [Translate Webchat UI](https://botpress.com/docs/docs/studio/guides/how-to/translate.md)
    - [Send reminders to conversations](https://botpress.com/docs/docs/studio/guides/how-to/send-reminders.md)
    - [Use different LLM for Autonomous Nodes](https://botpress.com/docs/docs/studio/guides/how-to/different-an-models.md)
    - [Track AI spend in a table](https://botpress.com/docs/docs/studio/guides/how-to/track-ai-spend-in-table.md)
    - [Send options as a dropdown menu](https://botpress.com/docs/docs/studio/guides/how-to/dropdown-menus.md)

### Advanced
    - [Using code in Studio](https://botpress.com/docs/docs/studio/guides/advanced/use-code.md)
    - [Event Properties](https://botpress.com/docs/docs/studio/guides/advanced/event-properties.md)
    - [State Management](https://botpress.com/docs/docs/studio/guides/advanced/best-practices-for-state-management.md)

#### Safety
      - [Safety](https://botpress.com/docs/docs/studio/guides/advanced/safety/introduction.md)
      - [Preventing Abuse](https://botpress.com/docs/docs/studio/guides/advanced/safety/preventing-abuse.md)
      - [Brand Safety Framework](https://botpress.com/docs/docs/studio/guides/advanced/safety/brand-safety-framework.md)

#### Exporting Data
      - [Exporting Data](https://botpress.com/docs/docs/studio/guides/advanced/exporting-data/introduction.md)
      - [Raw Conversations](https://botpress.com/docs/docs/studio/guides/advanced/exporting-data/exporting-raw-conversations-with-the-botpress-api.md)
      - [Conversation History](https://botpress.com/docs/docs/studio/guides/advanced/exporting-data/getting-the-conversation-history-from-within-your-bot.md)
      - [Streaming Analytics](https://botpress.com/docs/docs/studio/guides/advanced/exporting-data/streaming-analytics-from-within-your-bot-with-hooks.md)
      - [Compiled Bot Analytics](https://botpress.com/docs/docs/studio/guides/advanced/exporting-data/exporting-compiled-bot-analytics-with-the-botpress-api.md)
      - [Accessing The Autonomous Nodes Thought Process](https://botpress.com/docs/docs/studio/guides/advanced/exporting-data/analyze-llmz-responses.md)
    - [Advanced Starter Template](https://botpress.com/docs/docs/studio/guides/advanced/kitchen-sink-advanced-starter-template.md)
    - [Tips to optimize AI Cost](https://botpress.com/docs/docs/studio/guides/advanced/tips-to-optimize-ai-cost.md)
    - [Retention Period](https://botpress.com/docs/docs/studio/guides/advanced/retention-period.md)
    - [Botpress v12 (and self-hosted versions)](https://botpress.com/docs/docs/studio/guides/advanced/v12.md)

## Botpress Integrations
- [Introduction to Integrations](https://botpress.com/docs/docs/integrations/get-started/introduction.md)
- [Botpress Hub](https://botpress.com/docs/docs/integrations/get-started/botpress-hub.md)

## Guides
  - [Apify (Advanced Website Crawler)](https://botpress.com/docs/docs/integrations/integration-guides/plus-apify.md)
  - [Apollo](https://botpress.com/docs/docs/integrations/integration-guides/apollo.md)
  - [Attio](https://botpress.com/docs/docs/integrations/integration-guides/attio.md)
  - [Asana](https://botpress.com/docs/docs/integrations/integration-guides/asana.md)
  - [BambooHR](https://botpress.com/docs/docs/integrations/integration-guides/bamboohr.md)
  - [Canny](https://botpress.com/docs/docs/integrations/integration-guides/canny.md)
  - [Chat](https://botpress.com/docs/docs/integrations/integration-guides/chat.md)
  - [Chatwoot](https://botpress.com/docs/docs/integrations/integration-guides/chatwoot.md)
  - [Discord](https://botpress.com/docs/docs/integrations/integration-guides/discord.md)
  - [Email Notifier](https://botpress.com/docs/docs/integrations/integration-guides/plus-email-notifier.md)
  - [GitHub](https://botpress.com/docs/docs/integrations/integration-guides/github.md)
  - [Gmail](https://botpress.com/docs/docs/integrations/integration-guides/gmail.md)
  - [Google Analytics](https://botpress.com/docs/docs/integrations/integration-guides/plus-google-analytics.md)
  - [Google Calendar](https://botpress.com/docs/docs/integrations/integration-guides/googlecalendar.md)
  - [Google Sheets](https://botpress.com/docs/docs/integrations/integration-guides/gsheets.md)

### HITL
    - [Human-in-the-Loop (HITL)](https://botpress.com/docs/docs/integrations/integration-guides/hitl/introduction.md)
    - [Measure HITL Response Time](https://botpress.com/docs/docs/integrations/integration-guides/hitl/time-to-first-agent-response.md)
  - [HubSpot](https://botpress.com/docs/docs/integrations/integration-guides/hubspot.md)
  - [Hunter](https://botpress.com/docs/docs/integrations/integration-guides/hunter.md)
  - [Improvement](https://botpress.com/docs/docs/integrations/integration-guides/improvement.md)
  - [Instagram](https://botpress.com/docs/docs/integrations/integration-guides/instagram.md)
  - [Intercom](https://botpress.com/docs/docs/integrations/integration-guides/intercom.md)
  - [Klaviyo](https://botpress.com/docs/docs/integrations/integration-guides/klaviyo.md)
  - [Knowledge Base Optimizer](https://botpress.com/docs/docs/integrations/integration-guides/knowledge-base-optimization.md)
  - [Kommo](https://botpress.com/docs/docs/integrations/integration-guides/kommo.md)
  - [Line](https://botpress.com/docs/docs/integrations/integration-guides/line.md)
  - [Linear](https://botpress.com/docs/docs/integrations/integration-guides/linear.md)
  - [LinkedIn](https://botpress.com/docs/docs/integrations/integration-guides/linkedin.md)
  - [Loops](https://botpress.com/docs/docs/integrations/integration-guides/loops.md)
  - [MailerLite](https://botpress.com/docs/docs/integrations/integration-guides/mailerlite.md)
  - [Messenger and Facebook](https://botpress.com/docs/docs/integrations/integration-guides/messenger.md)
  - [Mintlify](https://botpress.com/docs/docs/integrations/integration-guides/mintlify.md)
  - [Persat](https://botpress.com/docs/docs/integrations/integration-guides/plus-persat.md)
  - [Microsoft Teams](https://botpress.com/docs/docs/integrations/integration-guides/teams.md)
  - [Notion](https://botpress.com/docs/docs/integrations/integration-guides/notion.md)
  - [Pipedrive](https://botpress.com/docs/docs/integrations/integration-guides/pipedrive.md)
  - [Slack](https://botpress.com/docs/docs/integrations/integration-guides/slack.md)

### Sunshine Conversation
    - [Sunshine Conversations](https://botpress.com/docs/docs/integrations/integration-guides/sunshine-conversations/introduction.md)
    - [Zendesk Messaging](https://botpress.com/docs/docs/integrations/integration-guides/sunshine-conversations/zendesk-messaging.md)
  - [Telegram](https://botpress.com/docs/docs/integrations/integration-guides/telegram.md)
  - [Trello](https://botpress.com/docs/docs/integrations/integration-guides/trello.md)
  - [Twilio](https://botpress.com/docs/docs/integrations/integration-guides/twilio.md)
  - [Viber](https://botpress.com/docs/docs/integrations/integration-guides/viber.md)
  - [Vonage](https://botpress.com/docs/docs/integrations/integration-guides/vonage.md)
  - [Webhook](https://botpress.com/docs/docs/integrations/integration-guides/webhook.md)
  - [Workable](https://botpress.com/docs/docs/integrations/integration-guides/workable.md)

### WhatsApp
    - [WhatsApp Setup](https://botpress.com/docs/docs/integrations/integration-guides/whatsapp/introduction.md)

#### Mapping
      - [Mapping from Botpress to WhatsApp](https://botpress.com/docs/docs/integrations/integration-guides/whatsapp/mapping/botpress-to-whatsapp.md)
      - [Mapping from WhatsApp to Botpress](https://botpress.com/docs/docs/integrations/integration-guides/whatsapp/mapping/whatsapp-to-botpress.md)
    - [Start a WhatsApp conversation proactively](https://botpress.com/docs/docs/integrations/integration-guides/whatsapp/whatsapp-start-proactively.md)
    - [Start a conversation on WhatsApp through a webhook](https://botpress.com/docs/docs/integrations/integration-guides/whatsapp/start-conversation-through-webhook.md)
  - [Zapier](https://botpress.com/docs/docs/integrations/integration-guides/zapier.md)
  - [Zendesk](https://botpress.com/docs/docs/integrations/integration-guides/zendesk.md)

## SDK
  - [Overview](https://botpress.com/docs/docs/integrations/sdk/overview.md)
  - [Installation](https://botpress.com/docs/docs/integrations/sdk/installation.md)

### Integrations
    - [Get started](https://botpress.com/docs/docs/integrations/sdk/integration/getting-started.md)
    - [Integration for Messaging Channels](https://botpress.com/docs/docs/integrations/sdk/integration/messaging.md)
    - [Integrations Concepts](https://botpress.com/docs/docs/integrations/sdk/integration/concepts.md)
    - [Publish your integration on Botpress Hub](https://botpress.com/docs/docs/integrations/sdk/integration/publish-your-integration-on-botpress-hub.md)
    - [Enable OAuth](https://botpress.com/docs/docs/integrations/sdk/integration/enable-oauth.md)
    - [Use your own LLM](https://botpress.com/docs/docs/integrations/sdk/integration/use-your-own-llm.md)

### Interfaces
    - [Introduction to interfaces](https://botpress.com/docs/docs/integrations/sdk/interface/introduction.md)
    - [How to implement an interface in your integration](https://botpress.com/docs/docs/integrations/sdk/interface/how-tos/add-and-implement.md)
    - [Implementing Human in the loop (HITL) in an integration](https://botpress.com/docs/docs/integrations/sdk/interface/how-tos/implementing-hitl.md)
    - [Implementing unidirectional file synchronization in an integration](https://botpress.com/docs/docs/integrations/sdk/interface/how-tos/implementing-file-sync.md)
  - [Bots-as-code](https://botpress.com/docs/docs/integrations/sdk/bots-as-code.md)
  - [CLI reference](https://botpress.com/docs/docs/integrations/sdk/cli-reference.md)

## Botpress Webchat
- [Introduction to Webchat](https://botpress.com/docs/docs/webchat/get-started/introduction.md)
- [Quickstart](https://botpress.com/docs/docs/webchat/get-started/quick-start.md)
- [Embed Webchat in an element](https://botpress.com/docs/docs/webchat/get-started/embed-in-element.md)
- [Configure Webchat](https://botpress.com/docs/docs/webchat/get-started/configure-your-webchat.md)

## Interact with Webchat
  - [Open/close your Webchat](https://botpress.com/docs/docs/webchat/interact/open-close-webchat.md)
  - [Use custom toggle to open/close Webchat](https://botpress.com/docs/docs/webchat/interact/use-custom-toggle.md)
  - [Display proactive bubble](https://botpress.com/docs/docs/webchat/interact/proactive-message-bubble.md)
  - [Automatically open Webchat on page load](https://botpress.com/docs/docs/webchat/interact/open-webchat-on-page-load.md)
  - [Send user data](https://botpress.com/docs/docs/webchat/interact/send-user-data.md)
  - [Listen to events](https://botpress.com/docs/docs/webchat/interact/listen-to-events.md)
  - [Trigger actions when conversation starts](https://botpress.com/docs/docs/webchat/interact/start-trigger.md)
  - [Display notification bubble](https://botpress.com/docs/docs/webchat/interact/webchat-notification.md)
  - [Send a message from user](https://botpress.com/docs/docs/webchat/interact/send-message.md)

### Send custom events
    - [Send custom events from Webchat to your website](https://botpress.com/docs/docs/webchat/interact/send-custom-events/from-webchat.md)
    - [Send custom events from your website to Webchat](https://botpress.com/docs/docs/webchat/interact/send-custom-events/to-webchat.md)
  - [Update Webchat configuration](https://botpress.com/docs/docs/webchat/interact/update-config.md)
  - [Error handling](https://botpress.com/docs/docs/webchat/interact/error-handling.md)
  - [Webchat methods reference](https://botpress.com/docs/docs/webchat/interact/reference.md)

## Integrations
  - [WordPress](https://botpress.com/docs/docs/webchat/integrations/wordpress.md)
  - [Wix](https://botpress.com/docs/docs/webchat/integrations/wix.md)
  - [Webflow](https://botpress.com/docs/docs/webchat/integrations/webflow.md)
  - [React Native](https://botpress.com/docs/docs/webchat/integrations/react-native.md)

## React library
  - [Get started](https://botpress.com/docs/docs/webchat/react-library/get-started.md)

### Components
    - [Webchat](https://botpress.com/docs/docs/webchat/react-library/components/webchat.md)
    - [Floating Action Button](https://botpress.com/docs/docs/webchat/react-library/components/fab.md)
    - [Container](https://botpress.com/docs/docs/webchat/react-library/components/container.md)
    - [Header](https://botpress.com/docs/docs/webchat/react-library/components/header.md)
    - [MessageList](https://botpress.com/docs/docs/webchat/react-library/components/message-list.md)
    - [Composer](https://botpress.com/docs/docs/webchat/react-library/components/composer.md)
    - [StylesheetProvider](https://botpress.com/docs/docs/webchat/react-library/components/stylesheet-provider.md)

### Hooks
    - [useWebchat](https://botpress.com/docs/docs/webchat/react-library/hooks/use-webchat-client.md)

## Botpress ADK

## Get started
  - [Introduction to the ADK](https://botpress.com/docs/docs/adk-v2/get-started/introduction.md)
  - [Quickstart](https://botpress.com/docs/docs/adk-v2/get-started/quickstart.md)
  - [Upgrading from ADK V1](https://botpress.com/docs/docs/adk-v2/get-started/upgrade-from-1x.md)

## Setting up your agent
  - [ADK concepts](https://botpress.com/docs/docs/adk-v2/setup/concepts.md)
  - [Project setup](https://botpress.com/docs/docs/adk-v2/setup/project-setup.md)
  - [Profiles](https://botpress.com/docs/docs/adk-v2/setup/profiles.md)
  - [Configuration](https://botpress.com/docs/docs/adk-v2/setup/configuration.md)
  - [Managing dependencies](https://botpress.com/docs/docs/adk-v2/setup/managing-dependencies.md)
  - [Dev Console overview](https://botpress.com/docs/docs/adk-v2/setup/dev-console.md)
  - [Team development](https://botpress.com/docs/docs/adk-v2/setup/team-development.md)

## Handling conversations
  - [Set up conversations](https://botpress.com/docs/docs/adk-v2/conversations/setup.md)
  - [Run AI agents in a conversation](https://botpress.com/docs/docs/adk-v2/conversations/ai-execution.md)
  - [Define tools](https://botpress.com/docs/docs/adk-v2/conversations/tools.md)
  - [Send messages and content](https://botpress.com/docs/docs/adk-v2/conversations/messages.md)
  - [Use custom components](https://botpress.com/docs/docs/adk-v2/conversations/custom-components.md)
  - [Manage conversation lifecycle](https://botpress.com/docs/docs/adk-v2/conversations/lifecycle.md)
  - [Manage state](https://botpress.com/docs/docs/adk-v2/conversations/state.md)

## Handling longform logic
  - [Create workflows](https://botpress.com/docs/docs/adk-v2/workflows/create.md)
  - [Use workflow steps](https://botpress.com/docs/docs/adk-v2/workflows/steps.md)
  - [Request and notify from workflows](https://botpress.com/docs/docs/adk-v2/workflows/request-notify.md)

## Actions and triggers
  - [Create actions](https://botpress.com/docs/docs/adk-v2/external/actions.md)
  - [Set up triggers](https://botpress.com/docs/docs/adk-v2/external/triggers.md)

## Working with data
  - [Tables](https://botpress.com/docs/docs/adk-v2/data/tables.md)
  - [Knowledge bases](https://botpress.com/docs/docs/adk-v2/data/knowledge.md)

## Testing and debugging
  - [Write and run evals](https://botpress.com/docs/docs/adk-v2/testing/evals.md)
  - [Agent steps](https://botpress.com/docs/docs/adk-v2/testing/agent-steps.md)
  - [Debug with logs and traces](https://botpress.com/docs/docs/adk-v2/testing/debugging.md)
  - [Run scripts](https://botpress.com/docs/docs/adk-v2/testing/scripts.md)
  - [Analytics](https://botpress.com/docs/docs/adk-v2/testing/analytics.md)
  - [Agent Map](https://botpress.com/docs/docs/adk-v2/testing/agent-map.md)

## LLM Utilities
  - [Introduction to Zai](https://botpress.com/docs/docs/adk-v2/zai/overview.md)
  - [Extract structured data](https://botpress.com/docs/docs/adk-v2/zai/extract.md)
  - [Generate text and summaries](https://botpress.com/docs/docs/adk-v2/zai/generate.md)
  - [Classify, validate and filter](https://botpress.com/docs/docs/adk-v2/zai/classify.md)

## AI-native development
  - [Building with Agent(0)](https://botpress.com/docs/docs/adk-v2/ai-native/agent0.md)
  - [Skills](https://botpress.com/docs/docs/adk-v2/ai-native/skills.md)

## Advanced
  - [Human-in-the-loop (HITL)](https://botpress.com/docs/docs/adk-v2/advanced/hitl.md)
  - [HITL with Desk](https://botpress.com/docs/docs/adk-v2/advanced/desk-hitl.md)

## CLI
  - [CLI reference](https://botpress.com/docs/docs/adk-v2/cli/cli-reference.md)

## Tutorial
- [Introduction](https://botpress.com/docs/docs/tutorial/introduction.md)

## Basics of Botpress

### First steps
    - [Prompting](https://botpress.com/docs/docs/tutorial/basics/first-steps/prompting.md)
    - [Adding knowledge](https://botpress.com/docs/docs/tutorial/basics/first-steps/adding-knowledge.md)

### Custom logic
    - [Workflows](https://botpress.com/docs/docs/tutorial/basics/custom-logic/workflows.md)
    - [Creating Nodes](https://botpress.com/docs/docs/tutorial/basics/custom-logic/creating-nodes.md)
    - [Adding Cards](https://botpress.com/docs/docs/tutorial/basics/custom-logic/adding-cards.md)
    - [Using custom logic with AI](https://botpress.com/docs/docs/tutorial/basics/custom-logic/using-custom-logic-with-ai.md)

### Storing information
    - [Variables](https://botpress.com/docs/docs/tutorial/basics/storing-information/variables.md)
    - [Assigning a value](https://botpress.com/docs/docs/tutorial/basics/storing-information/assigning-a-value.md)
    - [Scoping variables](https://botpress.com/docs/docs/tutorial/basics/storing-information/scoping-variables.md)

## Botpress Cloud API

## Get Started
  - [Introduction](https://botpress.com/docs/docs/api-reference.md)
  - [Authentication](https://botpress.com/docs/docs/api-reference/authentication.md)
  - [Pagination](https://botpress.com/docs/docs/api-reference/pagination.md)
  - [Rate limiting](https://botpress.com/docs/docs/api-reference/ratelimiting.md)
  - [Errors](https://botpress.com/docs/docs/api-reference/errors.md)

## Chat API
  - [Chat API Introduction](https://botpress.com/docs/docs/api-reference/chat-api/introduction.md)

### Endpoints
    - [getConversation](https://botpress.com/docs/docs/api-reference/chat-api/openapi/getConversation.md)
    - [deleteConversation](https://botpress.com/docs/docs/api-reference/chat-api/openapi/deleteConversation.md)
    - [listConversations](https://botpress.com/docs/docs/api-reference/chat-api/openapi/listConversations.md)
    - [createConversation](https://botpress.com/docs/docs/api-reference/chat-api/openapi/createConversation.md)
    - [getOrCreateConversation](https://botpress.com/docs/docs/api-reference/chat-api/openapi/getOrCreateConversation.md)
    - [listenConversation](https://botpress.com/docs/docs/api-reference/chat-api/openapi/listenConversation.md)
    - [listMessages](https://botpress.com/docs/docs/api-reference/chat-api/openapi/listMessages.md)
    - [listParticipants](https://botpress.com/docs/docs/api-reference/chat-api/openapi/listParticipants.md)
    - [addParticipant](https://botpress.com/docs/docs/api-reference/chat-api/openapi/addParticipant.md)
    - [getParticipant](https://botpress.com/docs/docs/api-reference/chat-api/openapi/getParticipant.md)
    - [removeParticipant](https://botpress.com/docs/docs/api-reference/chat-api/openapi/removeParticipant.md)
    - [getMessage](https://botpress.com/docs/docs/api-reference/chat-api/openapi/getMessage.md)
    - [deleteMessage](https://botpress.com/docs/docs/api-reference/chat-api/openapi/deleteMessage.md)
    - [createMessage](https://botpress.com/docs/docs/api-reference/chat-api/openapi/createMessage.md)
    - [getUser](https://botpress.com/docs/docs/api-reference/chat-api/openapi/getUser.md)
    - [updateUser](https://botpress.com/docs/docs/api-reference/chat-api/openapi/updateUser.md)
    - [deleteUser](https://botpress.com/docs/docs/api-reference/chat-api/openapi/deleteUser.md)
    - [createUser](https://botpress.com/docs/docs/api-reference/chat-api/openapi/createUser.md)
    - [getOrCreateUser](https://botpress.com/docs/docs/api-reference/chat-api/openapi/getOrCreateUser.md)
    - [getEvent](https://botpress.com/docs/docs/api-reference/chat-api/openapi/getEvent.md)
    - [createEvent](https://botpress.com/docs/docs/api-reference/chat-api/openapi/createEvent.md)

## Admin API
  - [Getting started](https://botpress.com/docs/docs/api-reference/admin-api/getting-started.md)
  - [Concepts](https://botpress.com/docs/docs/api-reference/admin-api/concepts.md)

### Endpoints
    - [getAccount](https://botpress.com/docs/docs/api-reference/admin-api/openapi/getAccount.md)
    - [updateAccount](https://botpress.com/docs/docs/api-reference/admin-api/openapi/updateAccount.md)
    - [listPublicIntegrations](https://botpress.com/docs/docs/api-reference/admin-api/openapi/listPublicIntegrations.md)
    - [getPublicIntegrationById](https://botpress.com/docs/docs/api-reference/admin-api/openapi/getPublicIntegrationById.md)
    - [getPublicIntegration](https://botpress.com/docs/docs/api-reference/admin-api/openapi/getPublicIntegration.md)
    - [listBots](https://botpress.com/docs/docs/api-reference/admin-api/openapi/listBots.md)
    - [createBot](https://botpress.com/docs/docs/api-reference/admin-api/openapi/createBot.md)
    - [getBot](https://botpress.com/docs/docs/api-reference/admin-api/openapi/getBot.md)
    - [updateBot](https://botpress.com/docs/docs/api-reference/admin-api/openapi/updateBot.md)
    - [deleteBot](https://botpress.com/docs/docs/api-reference/admin-api/openapi/deleteBot.md)
    - [getBotLogs](https://botpress.com/docs/docs/api-reference/admin-api/openapi/getBotLogs.md)
    - [getBotAnalytics](https://botpress.com/docs/docs/api-reference/admin-api/openapi/getBotAnalytics.md)
    - [getBotIssue](https://botpress.com/docs/docs/api-reference/admin-api/openapi/getBotIssue.md)
    - [deleteBotIssue](https://botpress.com/docs/docs/api-reference/admin-api/openapi/deleteBotIssue.md)
    - [listBotIssues](https://botpress.com/docs/docs/api-reference/admin-api/openapi/listBotIssues.md)
    - [listBotIssueEvents](https://botpress.com/docs/docs/api-reference/admin-api/openapi/listBotIssueEvents.md)
    - [listWorkspaces](https://botpress.com/docs/docs/api-reference/admin-api/openapi/listWorkspaces.md)
    - [createWorkspace](https://botpress.com/docs/docs/api-reference/admin-api/openapi/createWorkspace.md)
    - [getPublicWorkspace](https://botpress.com/docs/docs/api-reference/admin-api/openapi/getPublicWorkspace.md)
    - [getWorkspace](https://botpress.com/docs/docs/api-reference/admin-api/openapi/getWorkspace.md)
    - [updateWorkspace](https://botpress.com/docs/docs/api-reference/admin-api/openapi/updateWorkspace.md)
    - [deleteWorkspace](https://botpress.com/docs/docs/api-reference/admin-api/openapi/deleteWorkspace.md)
    - [listPublicWorkspaces](https://botpress.com/docs/docs/api-reference/admin-api/openapi/listPublicWorkspaces.md)
    - [getAuditRecords](https://botpress.com/docs/docs/api-reference/admin-api/openapi/getAuditRecords.md)
    - [listWorkspaceMembers](https://botpress.com/docs/docs/api-reference/admin-api/openapi/listWorkspaceMembers.md)
    - [createWorkspaceMember](https://botpress.com/docs/docs/api-reference/admin-api/openapi/createWorkspaceMember.md)
    - [getWorkspaceMember](https://botpress.com/docs/docs/api-reference/admin-api/openapi/getWorkspaceMember.md)
    - [updateWorkspaceMember](https://botpress.com/docs/docs/api-reference/admin-api/openapi/updateWorkspaceMember.md)
    - [deleteWorkspaceMember](https://botpress.com/docs/docs/api-reference/admin-api/openapi/deleteWorkspaceMember.md)
    - [listIntegrations](https://botpress.com/docs/docs/api-reference/admin-api/openapi/listIntegrations.md)
    - [createIntegration](https://botpress.com/docs/docs/api-reference/admin-api/openapi/createIntegration.md)
    - [validateIntegrationCreation](https://botpress.com/docs/docs/api-reference/admin-api/openapi/validateIntegrationCreation.md)
    - [getIntegration](https://botpress.com/docs/docs/api-reference/admin-api/openapi/getIntegration.md)
    - [updateIntegration](https://botpress.com/docs/docs/api-reference/admin-api/openapi/updateIntegration.md)
    - [deleteIntegration](https://botpress.com/docs/docs/api-reference/admin-api/openapi/deleteIntegration.md)
    - [validateIntegrationUpdate](https://botpress.com/docs/docs/api-reference/admin-api/openapi/validateIntegrationUpdate.md)
    - [getIntegrationLogs](https://botpress.com/docs/docs/api-reference/admin-api/openapi/getIntegrationLogs.md)
    - [getIntegrationByName](https://botpress.com/docs/docs/api-reference/admin-api/openapi/getIntegrationByName.md)

## Files API
  - [Getting started](https://botpress.com/docs/docs/api-reference/files-api/getting-started.md)
  - [Create files](https://botpress.com/docs/docs/api-reference/files-api/how-tos/creating-files.md)
  - [Index and search files](https://botpress.com/docs/docs/api-reference/files-api/how-tos/index-and-search-files.md)
  - [Manage files](https://botpress.com/docs/docs/api-reference/files-api/how-tos/manage-files.md)

### Endpoints
    - [listFiles](https://botpress.com/docs/docs/api-reference/files-api/openapi/listFiles.md)
    - [upsertFile](https://botpress.com/docs/docs/api-reference/files-api/openapi/upsertFile.md)
    - [getFile](https://botpress.com/docs/docs/api-reference/files-api/openapi/getFile.md)
    - [updateFileMetadata](https://botpress.com/docs/docs/api-reference/files-api/openapi/updateFileMetadata.md)
    - [deleteFile](https://botpress.com/docs/docs/api-reference/files-api/openapi/deleteFile.md)
    - [copyFile](https://botpress.com/docs/docs/api-reference/files-api/openapi/copyFile.md)
    - [searchFiles](https://botpress.com/docs/docs/api-reference/files-api/openapi/searchFiles.md)
    - [listFilePassages](https://botpress.com/docs/docs/api-reference/files-api/openapi/listFilePassages.md)
    - [listFileTags](https://botpress.com/docs/docs/api-reference/files-api/openapi/listFileTags.md)
    - [listFileTagValues](https://botpress.com/docs/docs/api-reference/files-api/openapi/listFileTagValues.md)

## Tables API
  - [Getting Started](https://botpress.com/docs/docs/api-reference/tables-api/getting-started.md)

### Endpoints
    - [listTables](https://botpress.com/docs/docs/api-reference/tables-api/openapi/listTables.md)
    - [createTable](https://botpress.com/docs/docs/api-reference/tables-api/openapi/createTable.md)
    - [getTable](https://botpress.com/docs/docs/api-reference/tables-api/openapi/getTable.md)
    - [getOrCreateTable](https://botpress.com/docs/docs/api-reference/tables-api/openapi/getOrCreateTable.md)
    - [updateTable](https://botpress.com/docs/docs/api-reference/tables-api/openapi/updateTable.md)
    - [deleteTable](https://botpress.com/docs/docs/api-reference/tables-api/openapi/deleteTable.md)
    - [duplicateTable](https://botpress.com/docs/docs/api-reference/tables-api/openapi/duplicateTable.md)
    - [renameTableColumn](https://botpress.com/docs/docs/api-reference/tables-api/openapi/renameTableColumn.md)
    - [getTableRow](https://botpress.com/docs/docs/api-reference/tables-api/openapi/getTableRow.md)
    - [findTableRows](https://botpress.com/docs/docs/api-reference/tables-api/openapi/findTableRows.md)
    - [createTableRows](https://botpress.com/docs/docs/api-reference/tables-api/openapi/createTableRows.md)
    - [updateTableRows](https://botpress.com/docs/docs/api-reference/tables-api/openapi/updateTableRows.md)
    - [deleteTableRows](https://botpress.com/docs/docs/api-reference/tables-api/openapi/deleteTableRows.md)
    - [upsertTableRows](https://botpress.com/docs/docs/api-reference/tables-api/openapi/upsertTableRows.md)

## Runtime API
  - [Getting Started](https://botpress.com/docs/docs/api-reference/runtime-api/getting-started.md)
  - [Concepts](https://botpress.com/docs/docs/api-reference/runtime-api/concepts.md)

### Endpoints
    - [listConversations](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/listConversations.md)
    - [createConversation](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/createConversation.md)
    - [getConversation](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/getConversation.md)
    - [updateConversation](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/updateConversation.md)
    - [deleteConversation](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/deleteConversation.md)
    - [getOrCreateConversation](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/getOrCreateConversation.md)
    - [listParticipants](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/listParticipants.md)
    - [addParticipant](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/addParticipant.md)
    - [getParticipant](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/getParticipant.md)
    - [removeParticipant](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/removeParticipant.md)
    - [listEvents](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/listEvents.md)
    - [createEvent](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/createEvent.md)
    - [getEvent](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/getEvent.md)
    - [cancelScheduledEvent](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/cancelScheduledEvent.md)
    - [listMessages](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/listMessages.md)
    - [createMessage](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/createMessage.md)
    - [getOrCreateMessage](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/getOrCreateMessage.md)
    - [getMessage](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/getMessage.md)
    - [updateMessage](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/updateMessage.md)
    - [deleteMessage](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/deleteMessage.md)
    - [listUsers](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/listUsers.md)
    - [createUser](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/createUser.md)
    - [getUser](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/getUser.md)
    - [updateUser](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/updateUser.md)
    - [deleteUser](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/deleteUser.md)
    - [getOrCreateUser](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/getOrCreateUser.md)
    - [setStateExpiry](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/setStateExpiry.md)
    - [getState](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/getState.md)
    - [setState](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/setState.md)
    - [patchState](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/patchState.md)
    - [getOrSetState](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/getOrSetState.md)
    - [callAction](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/callAction.md)
    - [configureIntegration](https://botpress.com/docs/docs/api-reference/runtime-api/openapi/configureIntegration.md)

## Changelog
- [Changelog](https://botpress.com/docs/docs/changelog.md)