Input:
{"body":{"maxTokens":2000,"messages":[{"content":"You are summarizing a text. The text is split into 1 parts, and you are currently working on part 1.\nAt every step, you will receive the current summary and a new part of the text. You need to amend the summary to include the new information (if needed).\nThe summary needs to cover the main points of the text and must be concise.\n\nIMPORTANT INSTRUCTIONS:\n- At each step, you will receive a part of the text to summarize. Make sure to reply with the new summary in the tags ■START■ and ■END■.\n- Summarize the text and make sure that the main points are included.\n- Ignore any unnecessary details and focus on the main points.\n- Use short and concise sentences to increase readability and information density.\n- When looking at the new information, focus on: Extract the Table of Contents for the Botpress Documentation. Pay special attention to all the different features. Focus on horizontal coverage of features rather than going in depth into one feature. The goal is to have a complete overview of what the documentation covers.\n- The current summary is empty. You need to generate a summary that covers the main points of the text.\n- This is the last part you will have to summarize. Make sure the summary is complete and covers all the main points.\n- The current summary is 0 tokens long. You need to make sure it is 2000 tokens or less.\n\nFORMAT OF THE SUMMARY:\nA normal text with multiple sentences and paragraphs. Use markdown to format the text into sections. Use headings, lists, and other markdown features to make the text more readable. Do not include links, images, or other non-text elements.","role":"system"},{"content":"■START■\n\n■END■\n\nPlease amend the summary between the ■START■ and ■END■ tags to accurately reflect the prompt and the additional text below.\n\n<|start_new_information|>\n**Botpress Documentation – Table of Contents Overview**\n\n---\n\n### 1��� Home & Getting Started  \n- **Home** – entry point to the docs.  \n- **Getting Started** – *Build*, *Deploy*, *Monitor* your bot.\n\n### 2��� Dashboard (Workspace & Bot)  \n#### Workspace  \n- Home, Members, Audits, Your integrations, Usage, Settings, Profile.  \n\n#### Bot  \n- Overview, Integrations, Webchat, Logs, Conversations, Analytics, Events, Issues, Configuration variables.\n\n### 3��� Studio (Bot Development UI)  \n- **Interface** – Nodes, Home, Flows, Knowledge Base, Tables.  \n- **Agents** – Summary, Personality, Policy, Translator, Knowledge, HITL, Vision, Analytics.  \n- **Library & Hooks** – reusable assets & lifecycle hooks.  \n- **Integrations, Schemas, Card Hub, Versions, Chatbot Settings.**  \n- **Utilities** – Find, Variables, Card Tray, Debugger/Logs/JSON, Emulator, Keyboard shortcuts, Commands, Preferences, Import/Export.  \n\n### 4��� Cards (Reusable Bot Actions)  \n- Send Messages, Execute code, Webchat, Flow Logic, AI (Tasks, Transitions, Generate Text).  \n\n### 5��� Webchat (Customer‑facing UI)  \n- **Webchat v2 (Embedded)** – Embedded Webchat, Custom CSS, React components, Webchat client.  \n- **Webchat v1 (Deprecated)** – JavaScript control, styling (button, header, input area), embedding options (React app, iframe, full‑screen).  \n- Flow logic, AI, Capture information, Events, Agents, Utilities.\n\n### 6��� Integrations  \n\n| Category | Highlights |\n|----------|------------|\n| **Usage** | Asana, HITL, Instagram, Intercom, Line, Messenger, Microsoft Teams, Notion, Slack, Sunshine Conversations, Telegram, Trello, Twilio, Viber, Vonage, Webhook, WhatsApp (manual config), Zapier, Zendesk. |\n| **Building** | Getting started, adding messaging channels, actions & triggers, publishing to Botpress Hub, custom LLM interfaces, live‑agent (HITL) setup, CLI, SDK, Key Concepts (Architecture, Tags, Channels, Config, User, Conversations, Messages, Events, States, Actions, Definitions, Secrets, ZUI), How‑to (states, register/unregister, integration actions/events, handlers, logging, custom integration). |\n\n#### Specific Integration Guides (high‑level steps)\n\n- **Zendesk** – Install via Integrations tab, configure API token, map user name/email to variables, enable HITL agent, add “Start��HITL” card, test in Web Chat.  \n- **Zapier** – Install Zapier integration, use “Send to Zapier” card (JSON payload) or “Event from Zapier” trigger, test with echo zap.  \n- **Wix** – Copy embedded Webchat script, add as custom code (Body‑Start), publish site, view widget.  \n- **WhatsApp** – Business verification, install integration, map Botpress content types to WhatsApp objects (text, media, location, interactive lists), handle button/drop‑down limits, retrieve media via access token, start conversations proactively with message templates (template name, language, variables, sender ID).  \n- **Webhook** – Enable integration, set URL & secret, send POST requests (Axios, curl, Postman), handle `Webhook Event` trigger in Studio, access `event.payload.body`, `.query`, `.method`.\n\n### 7��� Botpress APIs  \n- **Files API** – upload/download files.  \n- **Chat API** – programmatic conversation handling.\n\n### 8��� Appendix  \n- **Safety** – Preventing abuse, Brand safety framework.  \n- **Exporting Data** – Raw conversations, conversation history, streaming analytics (hooks), compiled bot analytics.\n\n---\n\n### Quick Navigation Snapshot  \n\n```\nHome → Getting Started → Dashboard\n   ├─ Workspace\n   ��─ Bot\nStudio → Interface / Agents / Library / Hooks / …  \nCards → Send / Execute / Webchat / AI  \nWebchat → v2 (Embedded) / v1 (Deprecated)  \nIntegrations → Usage (list) / Building (key concepts)  \nAPIs → Files / Chat  \nAppendix → Safety / Exporting Data\n```\n\nThis outline captures the full horizontal coverage of Botpress documentation, showing every major feature area without diving into detailed implementations.\n\n============\n\n# Botpress Documentation – Overview  \n\n## 1. Getting Started  \n- **Build, Deploy, Monitor** – Core setup steps for a new bot.  \n\n## 2. Dashboard (Workspace)  \n- **Workspace** – Manage multiple bots, members, audits, usage, settings, and profile.  \n- **Bot** – Overview, integrations, webchat, logs, conversations, analytics, events, issues, configuration variables.  \n\n## 3. Studio (Bot Development)  \n- **Interface** – Nodes, flows, knowledge base, tables.  \n- **Agents** – Summary, personality, policy, translator, knowledge, HITL, vision, analytics.  \n- **Library & Hooks** – Re‑usable components and lifecycle hooks.  \n- **Integrations & Schemas** – Connect external services, define data schemas.  \n- **Card Hub & Card Tray** – Collections of ready‑made cards (send messages, execute code, webchat, flow logic, AI).  \n- **Versions, Settings, Variables** – Versioning, bot configuration, global variables.  \n- **Debugging & Tools** – Debugger, logs, JSON viewer, emulator, keyboard shortcuts, commands, studio preferences, import/export.  \n\n## 4. Cards (Building Blocks)  \n- **Send Messages** – Text, media, quick replies.  \n- **Execute** – Run custom JavaScript.  \n- **Webchat** – Control the webchat widget (configure, show/hide, toggle).  \n- **Flow Logic** – Conditional routing, loops, sub‑flows.  \n- **AI** – Task, transition, generate‑text cards.  \n\n## 5. Webchat (Customer‑Facing Widget)  \n- **Webchat v1 (deprecated)** – JavaScript controls, styling (button, header, input, bot info), embedding options (React app, native, iframe, full‑screen).  \n- **Webchat v2** – Embedded webchat, custom CSS, React components, Webchat client library.  \n- **Platform Guides** – Integration steps for Webflow, Wix, WordPress.  \n- **Configuration** – Appearance, settings, generated embed code, testing console.  \n\n## 6. Integrations  \n### 6.1 Usage (Pre‑built)  \n- Asana, HITL, Instagram, Intercom, Line, Messenger, Microsoft Teams, Notion, Slack, Sunshine Conversations, Telegram, Trello, Twilio, Viber, Vonage, Webhook, WhatsApp (manual), Zapier, Zendesk.  \n\n### 6.2 Building Custom Integrations  \n- **Getting Started** – Messaging channel capabilities, actions & triggers, publishing to Botpress Hub.  \n- **LLM Interfaces** – Connect your own large language models.  \n- **Live‑Agent (HITL)** – Bridge to human support.  \n- **CLI & SDK** – Command‑line tools and software development kit.  \n- **Key Concepts** – Architecture, tags, channels, configuration, user, conversations, messages, events, states, actions, definitions, secrets, ZUI (Zod UI).  \n- **How‑to** – Register/unregister states, integration actions/events, handlers, logging, building custom integrations.  \n\n## 7. Botpress APIs  \n- **Files API** – Manage bot assets.  \n- **Chat API** – Send/receive messages programmatically.  \n\n## 8. Appendix  \n- **Safety** – Preventing abuse, brand‑safety framework.  \n- **Exporting Data** – Raw conversations, conversation history, streaming analytics, compiled bot analytics.  \n\n## 9. Utilities (Non‑workflow Cards)  \n- **Comment** – Annotate flows.  \n- **Image / Video** – Add visual media.  \n- **Log** – Console‑style logging with levels (debug, info, warning, error).  \n\n## 10. Workspace (Collaboration & Billing)  \n- Central hub for organizing bots, managing permissions, and applying add‑ons/plans per workspace.  \n\n## 11. Webhook & Event Filters (Advanced Triggering)  \n- Webhook events are `POST` requests with `event.payload.path` (e.g., `/new-comment`).  \n- **Filters** let you activate triggers only for specific paths or payload conditions (e.g., `event.payload.body.category === 'Business'`).  \n- Save important payload data to workflow variables, as `event.payload` is overwritten on each new message.  \n- You can scope webhooks to custom URLs (e.g., `/user`) and filter by `type` and `user.id`.  \n\n*This summary captures the full horizontal scope of Botpress documentation, listing every major section and feature without deep detail.*  \n**\n\n============\n\n# Botpress Documentation – High‑Level Overview  \n\n## 1. Core Areas  \n\n| Area | What you’ll find |\n|------|------------------|\n| **Getting Started** | Build, Deploy & Monitor bots; create and publish a Botpress Bot. |\n| **Dashboard** | Workspace admin (members, audits, integrations, usage, settings, profile). |\n| **Bot Management** | Overview, Integrations, Webchat, Logs, Conversations, Analytics, Events, Issues, Configuration variables. |\n| **Studio** | Visual flow editor (nodes, flows), Knowledge Base, Tables, Agents (summary, personality, policy, translator, knowledge, HITL, vision, analytics), Library, Hooks, Card Hub, Versions, Bot Settings, Debugger, Emulator, Keyboard shortcuts, Commands, Preferences, Import/Export. |\n| **Cards** | Send Messages, Execute code, Webchat, Flow Logic, AI. |\n| **Integrations** | Ready‑made channels (Asana, HITL, Instagram, Intercom, Line, Messenger, MS Teams, Notion, Slack, Sunshine, Telegram, Twilio, Viber, Vonage, Webhook, WhatsApp, Zapier, Zendesk) plus a **Building** guide (SDK, CLI, custom integrations, LLM use, architecture). |\n| **Webchat** | • **v1 (deprecated)** – JavaScript control, styling, embed options (React, iFrame, full‑screen).
• **v2** – Embedded Webchat, React components, Webchat client, custom CSS.
• **Installation** via Integration Hub, Shareable URL, Pre‑configured script (recommended) or Configurable script (manual updates). |\n| **Botpress APIs** | Files API, Chat API. |\n| **Appendix** | Safety (abuse prevention, brand safety), Exporting data (raw conversations, history, streaming analytics, compiled analytics). |\n\n## 2. Webchat Details (most‑used feature)  \n\n- **Installation** – Add through Integration Hub → “Install to Bot”.  \n- **Embedding options** – Pre‑configured script (paste into `<body>`), Configurable script (manual parameter edits).  \n- **Configurable Parameters** (selected defaults):  \n\n| Parameter | Description | Default | Type |\n|-----------|-------------|---------|------|\n| `stylesheet` | Custom CSS path | – | string |\n| `showConversationsButton` | Hide conversation list | `true` | boolean |\n| `showTimestamp` | Show timestamps | `false` | boolean |\n| `enableTranscriptDownload` | Allow transcript download | `true` | boolean |\n| `closeOnEscape` | Close on Esc key | `true` | boolean |\n| `botName`, `avatarUrl`, `botConversationDescription` | Branding info | – | string |\n| `locale` | Force UI language (`en`, `fr`, …) | `'browser'` | string |\n| `hideWidget`, `disableAnimations`, `useSessionStorage` | UI/behavior tweaks | `false` | boolean |\n| `containerWidth`, `layoutWidth` | Width of the widget | `360` | string/number |\n| `enablePersistHistory` | Persist messages locally | `true` | boolean |\n| `disableNotificationSound` | Silence new‑message sound | `false` | boolean |\n| `googleMapsAPIKey` | Show maps in chat | – | string |\n| `website`, `phoneNumber`, `termsConditions`, `privacyPolicy`, `emailAddress`, `coverPictureUrl` | Footer info pages | – | string |\n| `showBotInfoPage`, `showCloseButton` | Show extra UI buttons | `false` / `true` | boolean |\n| `userData`, `customUser` | Pass extra data to bot | – | object |\n\n- **Domain Whitelisting** (Team plan only) – restricts which domains may host the widget. Add allowed origins under *Advanced Settings* → *Allowed Origins*.  \n\n## 3. Variables – Scoped Data Storage  \n\n| Scope | Typical Use |\n|------|-------------|\n| **Workflow** | Temporary data inside a single flow (e.g., AI task output, user answers). |\n| **Session** | Data lives for the duration of a conversation (e.g., cart items). |\n| **User** | Persists across sessions for a particular user (profile, preferences, tags). |\n| **Bot** | Global config accessible to all users (bot name, version). |\n| **Configuration** (secure) | Secrets & environment variables (API keys, DB credentials). |\n\nAll variables are typed (String, Boolean, Number, Date, Object, Array, Enum, Pattern) and can be accessed in cards via `{{scope.varName}}` or `@scope.varName`.\n\n## 4. Usage & Limits  \n\n- **AI Spend** – Token‑based billing, free $5/month, cap $100/month (adjustable on dashboard).  \n- **File Storage** – MB used for media files.  \n- **Table Rows** – Number of rows across bot tables.  \n- **Vector DB Storage** – MB of vectorized knowledge‑base data (RAG).  \n- **Incoming Messages & Events** – Count of invocations before throttling.  \n- **Collaborators** – Max users in a workspace.  \n- **Bots** – Max bots per workspace (3 for pay‑as‑you‑go, 15 for Team plan).  \n- **Always‑Alive** – Reserve a warm instance to avoid cold‑start latency (per‑bot purchase).  \n\n## 5. Version Control  \n\n- Access via the clock‑icon in the left menu.  \n- **Create** manually (`+`) or automatically on each publish.  \n- **Revert** to any saved version (overwrites current state).  \n- Plan limits: 3 versions (pay‑as‑you‑go) or 15 (Team).  \n\n## 6. Profile & Security  \n\n- Update avatar, name, link social accounts, change password, generate personal access tokens.  \n- **Safety** – Prevent abuse and follow brand‑safety framework.  \n\n## 7. Export & Analytics  \n\n- Export raw conversations, conversation history, streaming analytics, compiled bot analytics via the Exporting Data section.  \n\n---  \n\n**Bottom Line** – Botpress provides a full‑stack, low‑code platform covering:  \n\n1. **Bot creation & deployment** (Dashboard, Studio, Versions).  \n2. **Rich UI & channel integrations** (Webchat v1/v2, dozens of pre‑built Messaging channels, custom integrations).  \n3. **Data handling** (Variables, storage limits, export tools).  \n4. **Operational insight** (Usage metrics, AI spend, safety, version history).  \n\nThis overview captures all major documentation sections without diving into any single feature, giving a complete horizontal map of what Botpress offers.\n\n============\n\n**Botpress Documentation – Table of Contents Overview**\n\n---  \n\n### 1��� Getting Started  \n- **Build** – creating a bot.  \n- **Deploy** – publishing to Cloud or on‑prem.  \n- **Monitor** – logging, analytics, health checks.  \n\n### 2��� Dashboard (Workspace)  \n- **Workspace home** – members, audits, usage, settings, profile.  \n- **Bot view** – overview, integrations, webchat, logs, conversations, analytics, events, issues, configuration variables.  \n\n### 3��� Studio (Design‑time UI)  \n- **Interface** – nodes, flows, knowledge base, tables.  \n- **Agents** – summary, personality, policy, translator, knowledge, HITL, vision, analytics.  \n- **Library & Hooks** – reusable actions & lifecycle scripts.  \n- **Integrations** – add external services.  \n- **Schemas, Card Hub, Versions** – data models & UI components.  \n- **Chatbot Settings, Find, Variables, Card Tray** – global config & debugging tools.  \n- **Debugger, Logs & JSON, Emulator** – testing & inspection.  \n- **Keyboard Shortcuts, Commands, Studio Preferences** – productivity features.  \n- **Import & Export** – moving bots between environments.  \n\n### 4��� Cards (Building Bot Logic)  \n- **Send Messages**, **Execute**, **Webchat**, **Flow Logic**, **AI**  \n  - AI sub‑features: **Task**, **Transition**, **Generate Text**.  \n\n### 5��� Webchat  \n- **Webchat v2 (Embedded)** – custom CSS, React components, client SDK.  \n- **Webchat v1 (Deprecated)** – JavaScript control, styling (button, header, input area), embedding (React, React‑Native, iframe, full‑screen).  \n- **Channel adapters** – Webflow, Wix, WordPress.  \n\n### 6��� Integrations  \n#### Usage (pre‑built connectors)  \n- Asana, HITL, Instagram, Intercom, Line, Messenger, Microsoft Teams, Notion, Slack, Sunshine Conversations, Telegram, Trello, Twilio, Viber, Vonage, Webhook, WhatsApp (manual config), Zapier, Zendesk.  \n\n#### Building Custom Integrations  \n- **Getting Started** – basics, adding messaging capabilities, actions & triggers, publishing to Botpress Hub.  \n- **LLM Interfaces** – plug‑your own large language model.  \n- **Live‑Agent (HITL)** – connect human agents.  \n- **Moving Parts, CLI, SDK** – development workflow.  \n- **Key Concepts** – architecture, tags, channels, configuration, user, conversations, messages, events, states, actions, definitions, secrets, ZUI (beta).  \n- **How‑to** – states lifecycle, register/unregister, integration actions/events, handlers, logging, building custom integrations.  \n\n### 7��� Botpress APIs  \n- **Files API** – manage bot assets.  \n- **Chat API** – programmatic conversation handling.  \n\n### 8��� Tables (Local Structured Storage)  \n- Creation, searchable fields, column types, filters (logical operators, rule groups).  \n- Operations via UI, Cards, Botpress client (list, create, find/filter, projection/aggregation, update, delete, upsert).  \n- CRUD via code (createRecord(s), deleteRecord(s), findRecords, getRecord, updateRecord, upsertRecords).  \n- **Computed Columns** – AI‑generated or code‑based values, auto‑compute toggle.  \n- Import/Export CSV, limits (10 tables, 20 columns, 10��000 rows on free plan).  \n\n### 9��� Streaming Analytics & Hooks  \n- Dashboard counters + charting.  \n- Using Hooks to forward events to third‑party services (e.g., Mixpanel) for inbound/outbound message analytics.  \n\n### �� Appendix  \n- **Safety** – preventing abuse, brand safety framework.  \n- **Exporting Data** – raw conversations, conversation history, streaming analytics, compiled bot analytics.  \n\n### 1���1��� Studio Preferences  \n- **Snap‑to‑Grid** – align nodes in flow editor.  \n- **Theme** – system, light, dark.  \n\n---  \n\n*This outline captures every major documentation section and feature, providing a horizontal view of Botpress’s capabilities without diving into the details of each page.*\n\n============\n\n**Botpress Documentation – Table of Contents Overview**\n\n---  \n\n### 1��� Getting Started  \n- **Build** – Create and configure bots.  \n- **Deploy** – Publish bots to production.  \n- **Monitor** – Observe bot health and performance.  \n\n### 2��� Dashboard (Workspace)  \n- **Workspace** – Central hub for all projects.  \n  - Home, Members, Audits, Integrations, Usage, Settings, Profile.  \n- **Bot** – Bot‑level views and controls.  \n  - Overview, Integrations, Webchat, Logs, Conversations, Analytics, Events, Issues, Configuration variables.  \n\n### 3��� Studio (Bot Designer)  \n- **Interface** – Visual editor for flows and assets.  \n- **Core Elements** – Nodes, Home, Flows, Knowledge Base, Tables.  \n- **Agents** – Ready‑made AI agents: Summary, Personality, Policy, Translator, Knowledge, HITL, Vision, Analytics.  \n- **Utility Sections** – Library, Hooks, Integrations, Schemas, Card Hub, Versions, Chatbot Settings, Find, Variables, Card Tray, Debugger/Logs/JSON, Emulator, Keyboard Shortcuts, Commands, Studio Preferences, Import��&��Export.  \n\n### 4��� Cards (Reusable Building Blocks)  \n- **Send Messages** – Text, media, quick replies, etc.  \n- **Execute** – Run code or actions.  \n- **Webchat** – Embed bot UI.  \n- **Flow Logic** – Conditional routing, loops.  \n- **AI** – AI Tasks, Transitions, Text Generation.  \n\n### 5��� Webchat (Customer‑Facing UI)  \n- **Webchat v2 (Embedded)** – Custom CSS, React components, client SDK.  \n- **Webchat v1 (Deprecated)** – JavaScript control, styling (buttons, headers, input area), embedding options (React, iframe, full‑screen).  \n- **Webflow / Wix / WordPress** – Platform‑specific integration guides.  \n\n### 6��� Integrations – Connecting External Services  \n\n#### a. Usage (Ready‑made channel integrations)  \n- **Project Management / Ticketing**: Asana, Trello,��Zendesk.  \n- **Live‑Chat / Messaging**: Slack, Telegram, WhatsApp, Messenger, Line, Viber, Vonage, Twilio,��Sunshine��Conversations,��Intercom,��Instagram,��Microsoft��Teams,��Discord (via webhook),��Zapier.  \n- **Other**: Twilio (SMS/voice),��Telegram (bot API),��Sunshine��Conversations (Smooch),��Viber,��Vonage,��Webhook.  \n\n#### b. Building (Create your own integration)  \n- **Getting Started** – Overview of integration development.  \n- **Messaging Channel Capabilities** – Add new channel support.  \n- **Actions & Triggers** – Extend Studio with custom logic.  \n- **Publish to Botpress Hub** – Distribute integrations.  \n- **LLM Interfaces** – Plug in custom large language models.  \n- **Live‑Agent Bridge (HITL)** – Connect human‑assistance platforms.  \n- **CLI / SDK** – Command‑line tools and software‑development kit.  \n- **Key Concepts** – Architecture, Tags, Channels, Configuration, Users, Conversations, Messages, Events, States, Actions, Definitions, Secrets, ZUI (Zod UI components).  \n\n### 7��� Botpress APIs  \n- **Files API** – Manage file storage.  \n- **Chat API** – Programmatic interaction with bots.  \n\n### 8��� Appendix  \n- **Safety** – Preventing abuse, brand‑safety framework.  \n- **Exporting Data** – Raw conversations, conversation history, streaming analytics, compiled bot analytics.  \n\n### 9��� Commands (Developer utilities)  \n- Quick commands usable in the Emulator or channel integrations (e.g., `//state/reset`) for troubleshooting and state management.  \n\n---  \n\n**Key Takeaway**: The Botpress documentation provides a comprehensive, horizontally organized reference covering everything from initial bot creation, through the full suite of UI‑building tools (Studio, Cards, Webchat), a rich catalog of ready‑to‑use integrations (Slack, Telegram, Trello, etc.), detailed guides for building custom integrations, core APIs, safety best practices, data‑export capabilities, and handy development commands. This structure enables developers to find any feature or guide quickly without diving deep into a single topic.\n\n============\n\n# Botpress Documentation – Overview of Topics  \n\n## 1. Getting Started  \n- **Build**, **Deploy**, **Monitor** – basic lifecycle steps for a bot.  \n\n## 2. Dashboard (Workspace)  \n- **Workspace Home**, **Members**, **Audits**, **Your integrations**, **Usage**, **Settings**, **Profile**.  \n- **Bot area** – Overview, Integrations, Webchat, Logs, Conversations, Analytics, Events, Issues, Configuration variables.  \n\n## 3. Studio – Design & Development  \n- **Interface** – Nodes, Flows, Knowledge Base, Tables.  \n- **Agents** – Summary, Personality, Policy, Translator, Knowledge, HITL, Vision, Analytics.  \n- **Library**, **Hooks**, **Integrations**, **Schemas**, **Card Hub**, **Versions**, **Chatbot Settings**, **Find**, **Variables**, **Card Tray**, **Debugger/Logs/JSON**, **Emulator**, **Keyboard Shortcuts**, **Commands**, **Preferences**, **Import‑Export**.  \n- **Cards** – Send Messages, Execute, Webchat, Flow Logic, AI.  \n- **Webchat** – Flow Logic, AI (Task, Transition, Generate Text), Capture Information, Events, Utilities.  \n\n## 4. Integrations  \n- **Usage** – Ready‑made connectors (Asana, HITL, Instagram, Intercom, Line, Messenger, Teams, Notion, Slack, Sunshine, Telegram, Trello, Twilio, Viber, Vonage, Webhook, WhatsApp��+��Manual config, Zapier, Zendesk).  \n- **Building** – Getting started, adding channel capabilities, actions & triggers, publishing to Botpress Hub.  \n- **Custom development** – Use your own LLM, live‑agent integration, CLI, SDK, Key Concepts (Architecture, Tags, Channels, Configuration, Users, Conversations, Messages, Events, States, Actions, Definitions, Secrets, ZUI).  \n- **How‑to** – States, Register/Unregister, Integration Actions, Integration Events, Handler, Logging, Building a custom integration.  \n\n## 5. Webchat  \n- **Current Webchat (v2)** – Embedded Webchat, Custom CSS, React components, Webchat client.  \n- **Legacy Webchat (v1 – deprecated)** – JavaScript control, styling (bot button, header, input area, bot info), embedding (React app, React Native, iframe, full‑screen).  \n- **Platform‑specific guides** – Webflow, Wix, WordPress.  \n\n## 6. Botpress APIs  \n- **Files API** – manage bot assets.  \n- **Chat API** – send/receive messages programmatically.  \n\n## 7. Appendix  \n- **Safety** – Preventing Abuse (rate limits, WAF, billing limits), Brand Safety Framework.  \n- **Exporting Data** – Raw conversations, conversation history, streaming analytics, compiled bot analytics.  \n\n## 8. Settings & Administration  \n- **General Settings** – Workspace name, handle, public profile, social links, deletion.  \n- **Billing** – Plans, AI spend limits, invoices, tax ID, receipt emails, subscription changes, pro‑rated upgrades.  \n\n## 9. SDK (Developer Toolkit)  \n- **Installation** – npm/yarn/pnpm.  \n- **Bot Development** – Bot class, message handlers, state & tag definitions, events, recurring events.  \n- **Integration Development** – Definition vs. implementation, actions, channels, events, states, user creation, example code.  \n\n## 10. Nodes (Conversation Logic)  \n- **Node Types** – Standard, Autonomous (LLM‑driven), Start (main flow), Entry (sub‑flows), Exit, End (session reset).  \n\n---\n\n*This summary provides a concise, horizontal view of all major sections and features covered in the Botpress documentation, enabling quick navigation to any area of interest.*  \n**\n\n============\n\n# Botpress Documentation – Table of Contents Overview  \n\n## 1. Home & Getting Started  \n- **Home** – entry point to the docs.  \n- **Build**, **Deploy**, **Monitor** – core guides to create, launch, and observe bots.  \n\n## 2. Dashboard  \n- **Workspace** – overall console view.  \n  - Home, Members, Audits, Your integrations, Usage, Settings, Profile.  \n- **Bot** – bot‑specific panels.  \n  - Overview, Integrations, Webchat, Logs, Conversations, Analytics, Events, Issues, Configuration variables.  \n\n## 3. Studio (Bot Design UI)  \n- **Interface** – main navigation.  \n  - Nodes, Home, Flows, Knowledge Base, Tables.  \n- **Agents** – pre‑built AI assistants.  \n  - Summary, Personality, Policy, Translator, Knowledge, HITL, Vision, Analytics.  \n- **Library & Hooks** – reusable components & lifecycle hooks.  \n- **Integrations, Schemas, Card Hub, Versions, Chatbot Settings** – project management tools.  \n- **Utilities** – Find, Variables, Card Tray, Debugger��/��Logs��/��JSON, Emulator, Keyboard Shortcuts, Commands, Studio Preferences, Import��&��Export.  \n\n## 4. Cards (Reusable Building Blocks)  \n- **Send Messages** – basic text, media, rich content.  \n- **Execute** – call actions or external services.  \n- **Webchat** – embed interactive chat UI.  \n- **Flow Logic** – conditionals, loops, transitions.  \n- **AI** – AI‑related cards (Task, Transition, Generate Text).  \n\n## 5. Webchat (Customer‑Facing Interface)  \n- **Webchat v2 (Embedded)** – modern embed with custom CSS, React components, Webchat client.  \n- **Webchat v1 (Deprecated)** – legacy JS control, styling (button, header, user input, bot info), embedding options (React app, React Native, iframe, full‑screen).  \n- Core features shared across versions:  \n  - Flow Logic, AI (Task/Transition/Generate Text), Capture Information, Events, Agents, Utilities.  \n\n## 6. Integrations  \n### 6.1 Usage (pre‑built channel connectors)  \n- **Asana**, **HITL**, **Instagram**, **Intercom**, **Line**, **Messenger**, **Microsoft��Teams**, **Notion**, **Slack**, **Sunshine��Conversations**, **Telegram**, **Trello**, **Twilio**, **Viber**, **Vonage**, **Webhook**, **WhatsApp** (Manual configuration), **Zapier**, **Zendesk**.  \n\n### 6.2 Building (custom integration development)  \n- **Getting Started** – overview, adding messaging channel capabilities, actions & triggers, publishing on Botpress Hub.  \n- **LLM Interfaces** – use your own large language model.  \n- **Live Agent (HITL)** – connect human‑agent platforms.  \n- **Moving Parts**, **CLI**, **SDK** – tooling for integration creation.  \n- **Key Concepts** – Architecture, Tags, Channels, Configuration, Users, Conversations, Messages, Events, States, Actions, Definitions, Secrets, ZUI (Zod UI components).  \n- **How‑to** – managing states, registering/unregistering, integration actions & events, handlers, logging, building a custom integration.  \n\n## 7. Botpress APIs  \n- **Files API** – manage file uploads/downloads.  \n- **Chat API** – programmatic message exchange with bots.  \n\n## 8. Appendix  \n- **Safety** – preventing abuse, brand‑safety framework.  \n- **Exporting Data** – raw conversations, conversation history, streaming analytics, compiled bot analytics.  \n\n### Quick Navigation Highlights  \n- **Debugger, Logs & JSON** → troubleshooting.  \n- **Keyboard Shortcuts** → productivity.  \n- **Studio Preferences** → UI customization.  \n- **Import & Export** → bot portability.  \n\n> This outline provides a horizontal view of every major feature area covered in the Botpress documentation, enabling rapid discovery of relevant guides without diving into deep technical detail.  \n\n**\n\n============\n\n# Botpress Documentation – Table of Contents Overview  \n\n## 1. Getting Started  \n- **Build** – Create a bot in Botpress Studio.  \n- **Deploy** – Publish bots to production.  \n- **Monitor** – Track bot health and performance.  \n\n## 2. Dashboard  \n- **Workspace** – Home, Members, Audits, Integrations, Usage, Settings, Profile.  \n- **Bot** – Overview, Integrations, Webchat, Logs, Conversations, Analytics, Events, Issues, Config variables.  \n\n## 3. Studio (Low‑code development)  \n- **Interface** – Nodes, Flows, Home, Knowledge��Base, Tables, Agents (Summary, Personality, Policy, Translator, Knowledge, HITL, Vision, Analytics).  \n- **Library & Hooks** – Re‑usable code blocks.  \n- **Integrations** – Connect external services.  \n- **Schemas & Card Hub** – Data modeling & UI components.  \n- **Versions, Settings, Preferences** – Bot versioning, chatbot configuration, studio preferences.  \n- **Find, Variables, Card Tray** – Search, runtime variables, reusable UI cards.  \n- **Debugger, Logs & JSON, Emulator** – Real‑time debugging, log inspection, conversation testing.  \n- **Keyboard Shortcuts & Commands** – Productivity shortcuts & CLI‑style commands.  \n- **Import��&��Export** – Bundle or extract bots.  \n\n## 4. Cards (Building bot behavior)  \n- **Send Messages** – Text, media, rich cards.  \n- **Execute** – Run code or actions.  \n- **Webchat** – Embedded chat UI.  \n- **Flow Logic** – Conditional routing, loops.  \n- **AI** – Tasks, transitions, text generation.  \n\n## 5. Webchat (Customer‑facing chat UI)  \n- **Webchat (v2 – current)** – Embedded Webchat, custom CSS, React components, Webchat client.  \n- **Webchat v1 (deprecated)** – JavaScript control, styling (button, header, input, bot info), embedding options (React app, React��Native, iframe, full‑screen).  \n- **Integrations** – Webflow, Wix, WordPress.  \n\n## 6. Integrations  \n- **Usage** – Ready‑made connectors: Asana, HITL, Instagram, Intercom, Line, Messenger, Microsoft��Teams, Notion, Slack, Sunshine��Conversations, Telegram, Trello, Twilio, Viber, Vonage, Webhook, WhatsApp (manual config), Zapier, Zendesk.  \n- **Building** – Create custom integrations: Getting started, messaging channel capabilities, actions & triggers, publishing to Botpress Hub.  \n- **LLM Interfaces** – Bring‑your‑own LLM: why, access, implementation steps (integration definition, generateContent & listModels actions, studio selection).  \n- **Moving Parts (Developer Experience)** – Public HTTP API, TypeScript HTTP client, SDK, CLI.  \n\n## 7. Botpress APIs  \n- **Files API** – Manage bot assets.  \n- **Chat API** – Programmatic conversation handling.  \n\n## 8. Knowledge Base (AI‑driven Q&A)  \n- **Agent** – Enable Knowledge��Base Agent.  \n- **Sources**  \n  - *Documents* – PDF, HTML, TXT, DOC/DOCX (max��100 files, 50��MB each).  \n  - *Website* – Add URLs or sitemap.  \n  - *Web Search* – Scoped or full‑web search, time‑range filters, include/exclude domains.  \n  - *Text Document* – Plain‑text FAQs, guides.  \n  - *Tables* – Structured data with searchable columns.  \n- **Storage quota** – 5��000 vectors (��200��articles or 1��000 PDF pages).  \n- **Capture‑Info cards** – Enable/disable KB lookup, control references, handle “no answer” cases, debug via logs & emulator.  \n\n## 9. Members & Permissions (RBAC)  \n- **Roles** – Viewer, Billing��Manager, Developer, Manager, Administrator, Owner (auto‑assigned).  \n- **Premium** – Dedicated RBAC for Team/Enterprise plans; PAYG can add/remove users.  \n\n## 10. Monitoring & Analytics  \n- **Event Debugger** – Real‑time event inspection.  \n- **Usage** – Message consumption & resource metrics.  \n- **Logs** – Production action/event log.  \n- **Conversations** – Transcript archive.  \n- **Analytics** – User counts, session stats, custom event tracking (Team/Enterprise).  \n- **Events & Issues** – Execution status & error tracking.  \n\n## 11. Appendix  \n- **Safety** – Preventing abuse, brand‑safety framework.  \n- **Exporting Data** – Raw conversations, conversation history, streaming analytics, compiled bot analytics.  \n\n---  \n*This concise overview captures the horizontal breadth of Botpress documentation, listing every major feature area without delving into detailed sub‑topics.*  \n**\n\n============\n\n# Botpress Documentation – Overview  \n\n## 1. Getting Started  \n- **Build** – Set up a Botpress instance.  \n- **Deploy** – Push bots to production.  \n- **Monitor** – Track bot performance and health.  \n\n## 2. Dashboard (Workspace)  \n- **Workspace Home** – Overview of workspace.  \n- **Members, Audits** – Manage team access and activity logs.  \n- **Integrations, Usage, Settings, Profile** – Configure workspace‑wide options.  \n\n## 3. Bot Management  \n- **Overview** – General bot information.  \n- **Integrations** – Connect external services (e.g., Intercom, Slack).  \n- **Webchat** – Embed chat widget (v1��deprecated, v2).  \n- **Logs, Conversations, Analytics, Events, Issues** – Inspect runtime data.  \n- **Configuration Variables** – Define env‑specific values.  \n\n## 4. Studio – Visual Bot Builder  \n### 4.1 Interface  \n- Nodes, Home, Flows, Knowledge Base, Tables.  \n\n### 4.2 Agents (AI assistants)  \n- Summary, Personality, Policy, Translator, Knowledge, HITL, Vision, Analytics.  \n\n### 4.3 Library (NLU)  \n- **Intents** – Create intents, add utterances, inline intents.  \n- **Entities** – System & custom (pattern & list) entities, usage in flows.  \n\n### 4.4 Hooks, Integrations, Schemas, Card Hub, Versions, Settings, Variables, Debugger, Emulator, Keyboard Shortcuts, Commands, Preferences.  \n\n### 4.5 Import & Export – Backup / share bots.  \n\n## 5. Cards (Reusable Bot Logic)  \n- **Send Messages** – Text, media, quick replies.  \n- **Execute** – Run custom code.  \n- **Webchat** – Advanced webchat features.  \n- **Flow Logic** – Conditional branching.  \n- **AI** – Tasks, transitions, text generation.  \n\n## 6. Webchat  \n- **Webchat v2 (Embedded)** – Custom CSS, React components, client SDK.  \n- **Webchat v1 (Deprecated)** – JS control, styling, embedding options (iframe, React, full‑screen).  \n\n## 7. Integrations – Connectors & Extensions  \n### 7.1 Usage (Installed integrations)  \n- Asana, HITL, Instagram, Intercom, Line, Messenger, Microsoft��Teams, Notion, Slack, Sunshine��Conversations, Telegram, Trello, Twilio, Viber, Vonage, Webhook, WhatsApp (manual config), Zapier, Zendesk.  \n\n### 7.2 Building New Integrations  \n- Getting started, adding channel capabilities, actions & triggers, publishing to Botpress Hub.  \n- **LLM Interfaces** – Hook your own large language model.  \n- **Live‑Agent (HITL)** – Human takeover.  \n- **CLI & SDK** – Command‑line tools, development kit.  \n\n### 7.3 Key Concepts (SDK structure)  \n1. **Tags** – Identify users, conversations, messages.  \n2. **Channels** – Supported communication channels.  \n3. **Configuration** – Store API keys & secrets.  \n4. **User** – Mapping external users to Botpress.  \n5. **Conversation** – Dialogue mapping.  \n6. **Messages** – Payload exchange format.  \n7. **States** – Scoped data storage (user‑, conversation‑, global).  \n8. **Actions** – Operations the integration can perform.  \n9. **Events** – Non‑conversational triggers.  \n10. **Definition** – Integration metadata.  \n11. **Secrets** – Secure handling of sensitive credentials.  \n\n## 8. APIs  \n- **Files API** – Manage bot assets.  \n- **Chat API** – Programmatic chat interactions.  \n\n## 9. Appendix  \n- **Safety** – Preventing abuse, brand‑safety framework.  \n- **Exporting Data** – Raw conversations, conversation history, streaming analytics, compiled bot analytics.  \n\n---  \n\n*This summary captures the full table of contents and main feature categories of the Botpress documentation, providing a high‑level map of all topics without diving into individual page details.*  \n**\n\n============\n\n**Botpress Documentation – Table of Contents Overview**\n\n---\n\n### 1��� Webchat  \n- **Core Webchat** – flow logic, AI (tasks, transitions, text generation), capture information, events, agents, utilities.  \n- **Webchat v1 (deprecated)** – JavaScript control, styling (chatbot button, header, input area, bot info), embedding options (React, React‑Native, iframe, full‑screen).  \n- **Webchat v2** – embedded webchat, custom CSS, React components, webchat client.  \n\n### 2��� Integrations  \n#### Usage (ready‑to‑install)  \n- Asana, HITL, Instagram, Intercom, Line, Messenger, Microsoft Teams, Notion, Slack, Sunshine Conversations, Telegram, Trello, Twilio, Viber, Vonage, Webhook, WhatsApp (manual config), Zapier, Zendesk.  \n\n#### Building Your Own  \n- **Getting Started** – install, add messaging channel capabilities, add actions & triggers, publish on Botpress Hub.  \n- **LLM Interfaces** – use your own LLM.  \n- **Live‑Agent (HITL) Integration** – connect live‑agent platforms.  \n- **Moving Parts, CLI, SDK** – development tools.  \n- **Key Concepts** – architecture, tags, channels, configuration, user, conversations, messages, events, states, actions, definitions, secrets, ZUI (Beta).  \n- **How‑to Guides** – states, register/unregister, integration actions & events, handlers, logging, building custom integrations.  \n\n### 3��� Botpress APIs  \n- **Files API** – upload, download, manage files; index documents for semantic search (RAG).  \n- **Chat API** – interact with bot conversations programmatically.  \n\n### 4��� Appendix  \n- **Safety** – preventing abuse, brand safety framework.  \n- **Exporting Data** – raw conversations, conversation history, streaming analytics, compiled bot analytics.  \n\n### 5��� Hooks (Custom Code Points)  \n- **Parameters** – event object, common hook arguments.  \n- **Usage** – after incoming message, before incoming message, before outgoing middleware.  \n\n### 6��� Instagram Integration (Setup)  \n- **Prerequisites** – Meta developer app, Facebook Page, Instagram Professional account.  \n- **Configuration** – enable integration, set webhook URL, app ID/secret, verify token, page ID, access token.  \n- **Steps** – create Facebook page, create Meta app (Business type), add Messenger product, upgrade API to v15+, retrieve app ID/secret, page ID & access token, generate verify token, save config, configure webhook with subscriptions (`instagram_manage_messages`, `messages`, `messaging_postbacks`).  \n- **Meta Review** – development mode limits, submit for public release.  \n\n### 7��� Human‑In‑The‑Loop (HITL) Guide  \n- **Concept** – HITL agent hands off conversation to live agents.  \n- **Integration Definition** – extend HITL interface, add hitl channel, define conversation & user tags.  \n- **Tags** – store ticket ID, additional data, agent‑platform user ID.  \n- **Lifecycle Methods** – `register`/`unregister` (webhook management).  \n- **Actions** – `createUser`, `startHitl`, `stopHitl`.  \n- **Channel Messages** – send user messages to live agent (`text` handler).  \n- **Handler** – process inbound agent events, map to Botpress users/conversations, emit `hitlAssigned` / `hitlStopped` events.  \n- **Full Example** – complete TypeScript/JS integration code.  \n\n### 8��� Raw Conversations (Export API)  \n- **Fetching** – GET `/chat/conversations` (Bearer token, bot ID), pagination via `nextToken`.  \n- **Client Library** – `@botpress/client` helpers (`listConversations`, `listMessages`).  \n- **Message Formatting** – utilities to render user vs. bot messages, handle text, quick replies, choices, media.  \n\n### 9��� Files API Details  \n- **Upload** – `client.uploadFile({ key, content })`; returns temporary URL (permanent if `public_content`).  \n- **Indexing** – uploaded files searchable for RAG.  \n- **Authentication** – follow API reference and auth guide.  \n\n---\n\n#### Quick Navigation Map\n| Section | Sub‑topics |\n|---|---|\n| **Webchat** | Flow Logic, AI, Styling, Embedding, v1/v2 |\n| **Integrations** | Usage (all listed platforms) • Building (Getting Started, LLM, HITL, SDK, Key Concepts) |\n| **APIs** | Files, Chat |\n| **Appendix** | Safety, Data Export |\n| **Hooks** | Parameters, After/Before Incoming, Before Outgoing |\n| **Instagram** | Prereqs, Config, Webhook, Meta Review |\n| **HITL** | Definition, Tags, Register/Unregister, Actions, Channel, Handler, Events |\n| **Raw Conversations** | List, Paginate, Messages, Formatting |\n| **Files API** | Upload, Indexing, URLs, Auth |\n\n*This overview captures the horizontal breadth of Botpress documentation, highlighting each major feature area without deep technical detail.*\n\n============\n\n# Botpress Documentation – Table of Contents Overview  \n\n## Getting Started  \n- **Examples**  \n- **Creating & uploading a file**  \n  - In an Execute Card  \n  - Custom script using the Botpress��Client  \n  - Custom script using an HTTP client  \n  - Adding tags to a file  \n  - Creating a public file / integrations‑only file  \n  - Creating an indexed file (semantic search)  \n\n## File Management Features  \n- **Supported file formats** (PDF, HTML, Text, Markdown)  \n- **Indexing notes** (status, async processing, error handling)  \n- **Metadata operations** – Get file, list files, filter by tags, pagination, update tags & access policies, delete files, update content (via replace)  \n- **Security & Access Policies**  \n  - `public_content` (public URL)  \n  - `integrations` (bot integrations)  \n- **Permissions matrix** (Public, Bot, Integration, Viewer, Developer/Manager/Admin, Billing)  \n\n## Pricing & Limits  \n- Storage (File��&��Vector DB)  \n- Quotas: 100��MB max file size, rate limits, tag limits, search query size (1��KB), max 50 results  \n\n## Botpress Studio (UI)  \n- **Dashboard** – Workspace, Bot, Home, Members, Audits, Settings, Profile  \n- **Bot** – Overview, Integrations, Webchat, Logs, Conversations, Analytics, Events, Issues, Config vars  \n- **Studio Interface**  \n  - Nodes, Flows, Knowledge Base, Tables, Agents (Summary, Personality, Policy, Translator, Knowledge, HITL, Vision, Analytics)  \n  - Library, Hooks, Integrations, Schemas, Card Hub, Versions, Chatbot Settings, Find, Variables, Card Tray, Debugger/Logs/JSON, Emulator, Keyboard shortcuts, Commands, Preferences, Import/Export  \n\n## Card Types & Flow Logic  \n- **Flow‑Logic Cards** – Intent, Expression (JavaScript)  \n- **Message Cards** – Send Messages, Execute, Webchat, AI (Task, Transition, Generate Text)  \n- **Utility Cards** – Capture Information, Events, Agents, Utilities  \n\n## Integrations Hub  \n- **Usage** – Asana, HITL, Instagram, Intercom, Line, Messenger, Microsoft Teams, Notion, Slack, Sunshine, Telegram, Trello, Twilio, Viber, Vonage, Webhook, WhatsApp, Zapier, Zendesk  \n- **Building** – Getting started, Messaging channel capabilities, Actions & triggers, Publishing to Botpress Hub, Custom LLMs, Live‑agent (HITL) integration, CLI, SDK, Key concepts (Architecture, Tags, Channels, Config, Users, Conversations, Messages, Events, States, Actions, Definitions, Secrets, ZUI)  \n\n## Webchat  \n- **Versions** – v1 (deprecated) & v2  \n  - Embedding options, custom CSS, React components, client SDK, styling (Chatbot button, Header, Input area)  \n\n## APIs  \n- **Files API** – Upload, list, get, update, delete, search (semantic)  \n- **Chat API** – Conversational endpoints  \n\n## Advanced Features  \n- **Find Function** – Quick search across flows, nodes, actions, variables, with contextual results and navigation  \n- **Conversation History** – Summary Agent, Hooks‑based history collection, export options (API, email, etc.)  \n- **Human‑in‑the‑Loop (HITL)** – Real‑time escalation, decision gates, audit trail, customizable triggers, usage flow (Escalate card, live chat tab, end conversation)  \n\n## Appendix  \n- **Safety** – Preventing abuse, brand‑safety framework  \n- **Exporting Data** – Raw conversations, conversation history, streaming analytics, compiled analytics  \n\n*This outline captures the horizontal breadth of Botpress documentation, listing all major sections and key features without deep technical detail.*  \n**\n\n============\n\n# Botpress Documentation – Table of Contents Overview  \n\n## 1. Getting Started  \n- **Build** – Design bots in **Studio** (flows, nodes, agents, knowledge base).  \n- **Deploy** – Publish bots, share via link, embed Webchat, use integrations or SDK.  \n- **Monitor** – Analytics, logs, events, and conversation tracking.  \n\n## 2. Dashboard / Workspace  \n- **Workspace** – Home, members, audits, integrations, usage, settings, profile.  \n\n## 3. Bot Management  \n- **Overview** – General bot info.  \n- **Integrations** – Connect to external services.  \n- **Webchat** – Built‑in chat UI (v1 deprecated, v2 embedded).  \n- **Logs** – System and bot‑level logs.  \n- **Conversations** – List, filter, inspect messages & JSON.  \n- **Analytics** – Usage metrics and dashboards.  \n- **Events** – Trigger and lifecycle events.  \n- **Issues** – Error tracking.  \n- **Configuration variables** – Environment‑level settings.  \n\n## 4. Studio (Bot Design)  \n- **Interface** – Nodes, home screen, flows, knowledge base, tables.  \n- **Agents** – Summary, Personality, Policy, Translator, Knowledge, HITL, Vision, Analytics.  \n- **Library & Hooks** – Re‑usable assets and lifecycle hooks.  \n- **Integrations** – Add custom channel or service integrations.  \n- **Schemas & Card Hub** – Data schemas and reusable UI cards.  \n- **Versions & Settings** – Bot versioning, chatbot settings.  \n- **Find / Variables / Card Tray** – Search, global variables, card management.  \n- **Debugger, Logs & JSON** – Real‑time event inspection.  \n- **Emulator** – Test conversations locally.  \n- **Keyboard Shortcuts, Commands, Preferences** – Productivity tools.  \n- **Import & Export** – Move bots between environments.  \n\n## 5. Cards (Building Bot Logic)  \n- **Send Messages** – Text, images, rich media.  \n- **Execute** – Run custom code.  \n- **Webchat** – Webchat‑specific actions.  \n- **Flow Logic** – Conditional routing, loops.  \n- **AI** – AI Task, AI Transition, AI Generate Text.  \n\n## 6. Webchat  \n- **Flow Logic** – Same as card flow logic for chat UI.  \n- **AI** – Task, transition, text generation.  \n- **Capture Information** – Extract user data into variables.  \n- **Events** – Webchat‑specific triggers (conversation started, trigger, etc.).  \n- **Agents** – Use bot agents inside Webchat.  \n- **Utilities** – Helper functions and UI components.  \n\n### 6.1 Webchat Versions  \n- **v1 (deprecated)** – JavaScript control, styling (button, header, input area), embedding (React, iframe, full‑screen).  \n- **v2 (embedded)** – Embedded widget, custom CSS, React components, Webchat client library.  \n\n## 7. Integrations  \n### 7.1 Usage (pre‑built)  \n- Asana, HITL, Instagram, Intercom, Line, Messenger, Microsoft Teams, Notion, Slack, Sunshine Conversations, Telegram, Trello, Twilio, Viber, Vonage, Webhook, WhatsApp (manual config), Zapier, Zendesk.  \n\n### 7.2 Building Custom Integrations  \n- **Getting Started** – Basics, messaging channel capabilities, actions & triggers, publishing to Botpress Hub.  \n- **LLM Interfaces** – Use your own Large Language Model.  \n- **Live Agent (HITL)** – Connect human agents.  \n- **Moving Parts, CLI, SDK** – Development tools.  \n- **Key Concepts** – Architecture, tags, channels, configuration, user, conversations, messages, events, states, actions, definitions, secrets, ZUI (beta).  \n- **How‑to** – Manage states, register/unregister, integration actions/events, handlers, logging, build custom integration.  \n\n## 8. Botpress APIs  \n- **Files API** – Manage bot assets.  \n- **Chat API** – Programmatic interaction with bots.  \n\n## 9. Appendix  \n- **Safety** – Preventing abuse, brand safety framework.  \n- **Exporting Data** – Raw conversations, conversation history, streaming analytics, compiled bot analytics.  \n\n## 10. Additional Tools & Pages  \n- **Events** – Overview of event types, filtering, statuses, and Webchat triggers (fixed schedule, cron, lifecycle).  \n- **Debugger, Logs & JSON** – Detailed payload inspection, logging best practices, state overview.  \n- **Emulator** – Shortcuts, new conversation, simulate timeout, inline logs (bot events, card processing, AI tasks, flow logic, capture information).  \n- **Conversations** – List and filter conversations by ID, message, participant, or integration; inspect message JSON and timestamps.  \n\n**Horizontal coverage:** The documentation spans the entire bot lifecycle—from initial **build** in Studio, through **deployment** options (shareable links, embedded Webchat, integrations, SDK), to ongoing **monitoring** via analytics, logs, events, and conversation management. It also provides deep technical references for **integrations**, **APIs**, **safety**, and **data export**, ensuring developers have a complete overview of all Botpress capabilities.\n\n============\n\n**Botpress Documentation – Table of Contents Overview**\n\n---\n\n### 1. Getting Started  \n- **Build** – creating a bot.  \n- **Deploy** – publishing to environments.  \n- **Monitor** – observing bot health and performance.  \n\n---\n\n### 2. Dashboard  \n**Workspace**  \n- Home, Members, Audits, Your integrations, Usage, Settings, Profile Setting  \n\n**Bot**  \n- Overview, Integrations, Webchat, Logs, Conversations, Analytics, Events, Issues, Configuration variables  \n\n---\n\n### 3. Studio  \n**Interface**  \n- Nodes, Home, Flows, Knowledge Base, Tables, Agents (Summary, Personality, Policy, Translator, Knowledge, HITL, Vision, Analytics)  \n\n**Core Features**  \n- Library, Hooks, Integrations, Schemas, Card Hub, Versions, Chatbot Settings, Find, Variables, Card Tray, Debugger��/��Logs��/��JSON, Emulator, Keyboard Shortcuts, Commands, Studio Preferences, Import��&��Export  \n\n---\n\n### 4. Cards  \n- Send Messages  \n- Execute (custom JavaScript, AI‑generated code)  \n- Webchat (embed & configure)  \n- Flow Logic  \n- AI (tasks, transitions, text generation)  \n\n---\n\n### 5. Webchat  \n- Flow Logic & AI (Task, Transition, Generate Text)  \n- Capture Information, Events, Agents, Utilities  \n\n**Webchat v1 (deprecated)**  \n- Controlling via JavaScript (init, mergeConfig, sendPayload, sendEvent, onEvent)  \n- Styling (Button, Header, Input Area, Bot Info)  \n- Embedding (React App, React Native, Iframe, Full‑screen)  \n\n**Webchat v2**  \n- Embedded Webchat (custom CSS)  \n- React Components  \n- Webchat Client  \n\n---\n\n### 6. Integrations  \n\n**Usage (pre‑built)** – Asana, HITL, Instagram, Intercom, Line, Messenger, Microsoft��Teams, Notion, Slack, Sunshine��Conversations, Telegram, Trello, Twilio, Viber, Vonage, Webhook, WhatsApp (manual config), Zapier, Zendesk  \n\n**Building (custom)**  \n- Getting Started, Adding Messaging Channel Capabilities, Adding Actions��&��Triggers, Publishing on Botpress��Hub  \n- Use Your Own LLM, Connect Live‑Agent Platform, Moving Parts, CLI, SDK  \n\n**Key Concepts** – Architecture, Tags, Channels, Configuration, User, Conversations, Messages, Event, States, Actions, Definitions, Secrets, ZUI (Zod UI components)  \n\n**How‑to** – States, Register��&��Unregister, Integration Actions, Integration Events, Handler, Logging, Building a Custom Integration  \n\n---\n\n### 7. Botpress APIs  \n- **Files API** – manage media & assets.  \n- **Chat API** – programmatic conversation handling.  \n\n---\n\n### 8. Appendix  \n\n**Safety** – Preventing Abuse, Brand Safety Framework  \n\n**Exporting Data** – Raw Conversations, Conversation History, Streaming Analytics (Hooks), Compiled Bot Analytics  \n\n---\n\n### 9. Advanced Topics (Optional)\n\n- **Execute Cards** – run custom JavaScript, AI‑generated code, error handling, access bot state.  \n- **Table Cards** – CRUD operations on bot tables (Get, Insert, Update, Delete, Find).  \n- **Embedded Webchat Quickstart** – obtaining embed code, adding to HTML, styling, controlling via the global `botpress` object (properties, methods, event listeners).  \n\n---\n\n*The documentation is organized to give you a complete, horizontal view of all Botpress capabilities—from initial setup and UI design in Studio, through bot logic with Cards and Webchat, to extending functionality with Integrations, APIs, and advanced custom code.*\n\n============\n\n**Botpress Documentation – Table of Contents Overview**\n\n---\n\n### 1��� Documentation Structure  \n\n| Main Area | Sub‑sections (selected) |\n|-----------|--------------------------|\n| **Home** | – |\n| **Getting Started** | Build • Deploy • Monitor |\n| **Dashboard** | Workspace (Home, Members, Audits, Integrations, Usage, Settings, Profile) |\n| **Bot** | Overview • Integrations • Webchat • Logs • Conversations • Analytics • Events • Issues • Configuration variables |\n| **Studio** | Interface (Nodes, Home, Flows) • Knowledge Base • Tables • Agents (Summary, Personality, Policy, Translator, Knowledge,��HITL,��Vision,��Analytics) • Library • Hooks • Integrations • Schemas • Card Hub • Versions • Chatbot Settings • Find • Variables • Card Tray • Debugger/Logs/JSON • Emulator • Keyboard Shortcuts • Commands • Preferences • Import��&��Export |\n| **Cards** | Send Messages • Execute • Webchat • Flow Logic • **AI** (Task, Transition, Generate Text) |\n| **Webchat** | Flow Logic • AI (Task, Transition, Generate Text) • Capture Information • Events • Agents • Utilities |\n| **Integrations** | *Usage*: Asana, HITL, Instagram, Intercom, Line, Messenger, Microsoft Teams, Notion, Slack, Sunshine Conversations, Telegram, Trello, Twilio, Viber, Vonage, Webhook, WhatsApp (manual), Zapier, Zendesk • *Building*: Getting Started, Adding Messaging Channels, Adding Actions & Triggers, Publishing on Botpress Hub, Use Your Own LLM, Connect Live Agent, Moving Parts, CLI, SDK, Key Concepts (Architecture, Tags, Channels, Configuration, User, Conversations, Messages, Event, States, Actions, Definitions, Secrets, ZUI), How‑to (States, Register��&��Unregister, Integration Actions, Integration Events, Handler, Logging, Building a Custom Integration) |\n| **Webchat Versions** | v1 (deprecated) – JS control, styling, embedding (React, Iframe, Full‑screen) • v2 – Embedded Webchat, Custom CSS, React components, Webchat client |\n| **Botpress APIs** | Files API • Chat API |\n| **Appendix** | Safety (Preventing Abuse, Brand Safety Framework) • Exporting Data (Raw Conversations, Conversation History, Streaming Analytics, Compiled Bot Analytics) |\n\n---\n\n### 2��� Capture Information – Prompt Field Types  \n\n| Type | Extracted Variable | Description |\n|------|-------------------|-------------|\n| **SingleChoice** | String | One option from a list |\n| **MultipleChoice** | String | One or more options |\n| **Boolean** | Boolean | True/False (Yes/No) |\n| **Confirmation** | Boolean | Accept/Decline |\n| **Number** | Number | Numeric input |\n| **EmailAddress** | String | Valid email |\n| **PhoneNumber** | String | Phone number (optional country code) |\n| **FullAddress** | Object | Country, city, street, zip, number |\n| **Price** | Number | Monetary amount (currency‑agnostic) |\n| **RawInput** | String | Unprocessed user text |\n| **Percentage** | Number | Decimal representation of % |\n| **Quantity** | Number | Quantity irrespective of unit |\n| **Color** | Object | Name, HEX, RGB |\n| **TimeMeasurement** | Number | Duration (ns,��µs,��ms,��s,��min,��h,��d,��week,��month,��year) |\n| **WeightMeasurement** | Number | Weight (mcg,��mg,��g,��kg,��oz,��lb,��mt,��t) |\n| **CronSchedule** | Object | Cron expression + repeatable flag |\n| **OperatingSystem** | Object | OS name & version |\n| **QuantityOfPeople** | Number | Number of persons |\n| **VolumeMeasurement** | Number | Various volume units (ml,��l,��gal,��ft³, …) |\n| **TemperatureMeasurement** | Number | °C,��K,��°F |\n| **Person** | Object | First & last name |\n| **DateTime** | Object | Date or duration (e.g., “next week”) |\n| **WaitForUserInput** | – | Pauses flow until user replies |\n\n---\n\n### 3��� Custom Prompt Fields  \n\n| Type | Use case |\n|------|----------|\n| **Entity – Regex** | Capture data matching a custom regular expression (e.g., credit‑card number). |\n| **Entity – List** | Match input against a predefined list/synonyms with fuzzy matching (Strict / Medium / Loose). |\n\n---\n\n### 4��� Advanced Configuration  \n\n| Feature | What it controls |\n|----------|-------------------|\n| **Retries** | Number of re‑asks and custom retry message. |\n| **Validation** | Label‑based or code‑based input checks with custom failure message. |\n| **Extract from History** | Pull values from previous N messages. |\n| **Cancellation** | Allow user to abort capture, optional confirmation. |\n| **Choices** | Define static or dynamic options (buttons vs. dropdown). |\n| **Advanced Flags** | *Add transition to handle failure*; *Skip if variable already filled*. |\n\n---\n\n### 5��� Prompt Chaining  \n\n- Sequence multiple Capture Information cards to extract several values from a single user message.  \n- Each card can fall back to asking the user if its value isn’t found, using **Extract from History** to reuse prior input.\n\n---\n\n### 6��� Quick Reference – Key Concepts & Tools  \n\n- **CLI** – Install (`npm i -g @botpress/cli`), commands for login, bots, integrations, init, generate, bundle, build, serve, deploy.  \n- **SDK** – Extends bot functionality; includes architecture, tags, channels, configuration, secrets, ZUI components.  \n- **Key Concepts** – Architecture, tags, channels, configuration, user, conversations, messages, events, states, actions, definitions, secrets.  \n- **Agents** – Specialized bots (Summary, Personality, Policy, Translator, Knowledge, HITL, Vision, Analytics).  \n\n---\n\n### 7��� Safety & Data Export  \n\n- **Safety** – Preventing abuse, brand safety framework.  \n- **Exporting Data** – Raw conversations, conversation history, streaming analytics, compiled bot analytics via Botpress APIs.\n\n---\n\n*This concise overview captures the horizontal coverage of Botpress documentation, highlighting all major sections, feature groups, and the extensive set of capture‑information field types.*\n\n============\n\n**Botpress Documentation – Table of Contents Overview**\n\n---\n\n### 1. Home & Getting Started\n- **Home** – entry point to all docs.  \n- **Getting Started** – Build, Deploy, Monitor guides.\n\n### 2. Dashboard\n- **Workspace** – Home, Members, Audits, Integrations, Usage, Settings, Profile.  \n- **Bot** – Overview, Integrations, Webchat, Logs, Conversations, Analytics, Events, Issues, Configuration variables.\n\n### 3. Studio (Bot Development Environment)\n- **Interface** – Nodes, Flows, Knowledge Base, Tables.  \n- **Agents** – Summary, Personality, Policy, Translator, Knowledge, HITL, Vision, Analytics.  \n- **Library & Hooks** – Re‑usable code & event hooks.  \n- **Integrations & Schemas** – Connect external services & define data structures.  \n- **Card Hub & Card Tray** – Browse, install, drag‑and‑drop pre‑built workflow Cards.  \n- **Versions & Settings** – Bot versioning, Chatbot Settings.  \n- **Utilities** – Find, Variables, Debugger/Logs/JSON, Emulator, Keyboard shortcuts, Commands, Studio Preferences, Import/Export.\n\n### 4. Cards (Modular Actions)\n- **Send Messages** – Text, media, quick replies.  \n- **Execute** – Run custom code or actions.  \n- **Webchat** – Embed Webchat UI components.  \n- **Flow Logic** – Conditional branching, loops.  \n- **AI** – Tasks, Transitions, Generate Text.\n\n### 5. Webchat\n- **Core Features** – Flow Logic, AI (tasks, transitions, generation), Capture Information, Events, Agents, Utilities.  \n- **Versions**  \n  - *v1 (deprecated)* – JavaScript control, styling, embedding (React, iframe, full‑screen).  \n  - *v2* – Embedded Webchat, Custom CSS, React components, Webchat client.\n\n### 6. Integrations\n- **Usage** – Ready‑made connectors: Asana, HITL, Instagram, Intercom, Line, Messenger, Teams, Notion, Slack, Sunshine, Telegram, Trello, Twilio, Viber, Vonage, Webhook, WhatsApp (manual config), Zapier, Zendesk.  \n- **Building** – Getting started, Messaging channel capabilities, Actions & triggers, Publishing to Botpress Hub.  \n- **Custom Development** – Use your own LLM, HITL integration, Moving parts, CLI, SDK.  \n- **Key Concepts** – Architecture, Tags, Channels, Configuration, User, Conversations, Messages, Events, States, Actions, Definitions, Secrets, ZUI (beta).\n\n### 7. Botpress APIs\n- **Files API** – Manage bot assets.  \n- **Chat API** – Backend‑to‑bot HTTP interface (setup, demo, npm package).\n\n### 8. Appendix\n- **Safety** – Preventing Abuse, **Brand Safety Framework** (Policy Agent, RAG Safety, LLM Inspector, HITL).  \n- **Exporting Data** – Raw conversations, Conversation history, Streaming analytics, Compiled bot analytics.\n\n### 9. Specialized Sections\n- **Card Tray** – Access installed Cards, drag‑and‑drop workflow building, customization, sharing.  \n- **Card Hub** – Search, install, customize, and share community Cards.  \n- **Agents** – Agent‑specific Cards (e.g., Knowledge Agent for querying knowledge bases).  \n- **Brand Safety Framework** – LLM transparency, policy enforcement, RAG safety, inspector UI, Human‑in‑the‑Loop (HITL) for escalations.\n\n---\n\n**Key Takeaway:** The Botpress documentation is organized horizontally across major functional domains—**Dashboard, Studio, Cards, Webchat, Integrations, APIs, and Safety**—providing a comprehensive map of all features, tools, and extensions to build, deploy, monitor, and secure AI‑driven chatbots.\n\n============\n\n# Botpress Documentation – Overview  \n\n## 1. Getting Started  \n- **Build** – Create bots in **Studio** (design flows, knowledge bases, tables, agents).  \n- **Deploy** – Publish bots to Webchat, channels, or custom integrations.  \n- **Monitor** – Use the **Analytics** tab for usage metrics, custom boards, and event tracking.  \n\n## 2. Dashboard (Workspace��/��Bot)  \n| Area | Sub‑pages |\n|------|-----------|\n| **Workspace** | Home, Members, Audits, Integrations, Usage, Settings, Profile |\n| **Bot** | Overview, Integrations, Webchat, Logs, Conversations, Analytics, Events, Issues, Config��Variables |  \n\n## 3. Studio – Core Editing UI  \n- **Interface**: Nodes, Home, Flows, Knowledge Base, Tables.  \n- **Agents** (each with dedicated cards): Summary, Personality, Policy, Translator, Knowledge, HITL, Vision, Analytics.  \n- **Utilities**: Library, Hooks, Schemas, Card Hub, Versions, Settings, Find, Variables, Card Tray, Debugger/Logs/JSON, Emulator, Keyboard shortcuts, Commands, Preferences, Import��/��Export.  \n\n## 4. Cards (building‑block actions)  \n- **Send Messages** – Text, media, rich UI.  \n- **Execute** – Run custom code or actions.  \n- **Webchat** – Embed or control chat UI.  \n- **Flow Logic** – Conditionals, loops, transitions.  \n- **AI** – Direct LLM‑powered tasks:  \n  - **AI��Task** – Structured LLM request (e.g., summarise, classify).  \n  - **AI��Transition** – Route flow based on LLM output.  \n  - **AI��Generate��Text** – Free‑form generation (answers, drafts).  \n\n## 5. Webchat Implementations  \n- **v1 (deprecated)** – JS control, styling, embedding (iframe, React, React��Native, Full‑screen).  \n- **v2** – Embedded Webchat with custom CSS, React components, and a dedicated client SDK.  \n\n## 6. Integrations (Usage��/��Building)  \n### 6.1 Pre‑built integrations  \nAsana, HITL, Instagram, Intercom, Line, Messenger, Microsoft��Teams, Notion, Slack, Sunshine��Conversations, Telegram, Trello, Twilio, Viber, Vonage, Webhook, WhatsApp (manual config), Zapier, Zendesk.  \n\n### 6.2 Building custom integrations  \n- **Getting Started** – Messaging channel, actions & triggers.  \n- **Key Concepts** – Architecture, Tags, Channels, Config, Users, Conversations, Messages, Events, States, Actions, Definitions, Secrets.  \n- **Tools** – CLI, SDK (`@botpress/sdk`), API reference, custom handlers, registration hooks.  \n\n## 7. Botpress APIs  \n- **Files API** – Manage bot files (assets, configs).  \n- **Chat API** – Programmatic interaction with bots (send/receive messages).  \n\n## 8. Appendix  \n- **Safety** – Abuse prevention, brand‑safety framework.  \n- **Exporting Data** – Raw conversations, conversation history, streaming analytics (hooks), compiled bot analytics.  \n\n## 9. Analytics��/��Monitoring  \n- **Default Layout** – Charts for users, sessions, messages (bot��/��user��/��total), averages, custom events.  \n- **Custom Boards** – Add/edit charts, select time periods.  \n- **Event Types** – Users, sessions, messages, custom bot‑ready/published/state��expired, conversationStarted, etc.  \n- **Chart Types** – Area, donut, bar, pie, metric, spark bar, spark area.  \n- **Analytics Agent** (Team plan) – Track custom events via “Track Event” card; data appears within ~1��hour.  \n\n## 10. AI‑Centric Platform Features  \n- **Agent Studio** – Visual flow builder with AI‑enhanced cards.  \n- **Autonomous Engine** – LLM‑driven conversation routing & task execution.  \n- **Knowledge Bases** – Import & query custom data (websites, PDFs, docs).  \n- **Tables** – Structured storage for vectorised or relational data.  \n\n## 11. Ecosystem & Resources  \n- **Hub** – Browse integrations, channels, LLM providers (OpenAI, Anthropic, Meta, Groq, Cerebras, Hugging��Face).  \n- **Solutions** – Enterprise, Agency, Developer tracks.  \n- **Learning** – Botpress Academy, guides, video tutorials, community Discord.  \n- **Community & Support** – Forums, partners, expert marketplace, live office hours.  \n\n### Quick Reference – Main Navigation  \n- **Home → Getting��Started → Dashboard → Studio → Cards → Webchat → Integrations → APIs → Appendix → Analytics → AI Features → Hub & Resources**  \n\n*The documentation provides a comprehensive, horizontally‑structured catalogue of every Botpress component, from core studio editing to AI cards, integrations, APIs, analytics, and safety tooling, enabling developers to locate any feature without diving deep into a single area.*  \n**\n<|new_information|>","role":"user","type":"text"}],"meta":{"integrationName":"zai","promptCategory":"zai:summarize","promptSource":"zai:summarize:default"},"model":"fast","signal":{},"stopSequences":["■END■"]},"method":"POST","url":"https://api.botpress.cloud/v2/cognitive/generate-text"}

Output:
**Botpress Documentation – Horizontal Overview**

---

## 1. Getting Started
- **Build** – Create a bot in **Studio** (flows, agents, knowledge base, tables).
- **Deploy** – Publish to Cloud, on‑prem, embed Webchat, or connect via integrations/SDK.
- **Monitor** – Use built‑in analytics, logs, and health dashboards to track usage and performance.

---

## 2. Dashboard (Workspace & Bot)
| Area | Core Pages |
|------|------------|
| **Workspace** | Home, Members, Audits, Integrations, Usage, Settings, Profile. |
| **Bot** | Overview, Integrations, Webchat, Logs, Conversations, Analytics, Events, Issues, Configuration variables. |

- Central hub for project organization, permission management, and billing.

---

## 3. Studio (Low‑code Bot Designer)
- **Interface** – Nodes, Flows, Knowledge Base, Tables.
- **Agents** – Ready‑made AI assistants: Summary, Personality, Policy, Translator, Knowledge, HITL, Vision, Analytics.
- **Library & Hooks** – Re‑usable actions and lifecycle scripts.
- **Integrations & Schemas** – Connect external services and define data structures.
- **Card Hub & Card Tray** – Browse, install, and drag‑drop pre‑built Cards.
- **Versions & Settings** – Bot versioning, global chatbot configuration.
- **Utilities** – Find (search), Variables (workflow, session, user, bot, secret), Debugger/Logs/JSON, Emulator, Keyboard shortcuts, Commands, Preferences, Import/Export.

---

## 4. Cards (Modular Building Blocks)
- **Send Messages** – Text, media, quick replies, rich cards.
- **Execute** – Run custom JavaScript or actions.
- **Webchat** – Control or embed the chat widget.
- **Flow Logic** – Conditional routing, loops, sub‑flows.
- **AI** – Task, Transition, Generate‑Text cards for LLM‑driven operations.

---

## 5. Webchat (Customer‑Facing UI)
- **v2 (Embedded)** – Modern widget, custom CSS, React components, Webchat client SDK.
- **v1 (Deprecated)** – JavaScript control, styling (button, header, input), embedding options (React app, iframe, full‑screen).
- Shared features: flow logic, AI cards, capture‑information, events, agents, utilities.

---

## 6. Integrations
### 6.1 Usage (Pre‑built Connectors)
Asana, HITL, Instagram, Intercom, Line, Messenger, Microsoft Teams, Notion, Slack, Sunshine Conversations, Telegram, Trello, Twilio, Viber, Vonage, Webhook, WhatsApp (manual), Zapier, Zendesk.

### 6.2 Building Custom Integrations
- **Getting Started** – Add a messaging channel, define actions & triggers, publish on Botpress Hub.
- **Key Concepts** – Architecture, tags, channels, configuration, users, conversations, messages, events, states, actions, definitions, secrets, ZUI (beta).
- **Tools** – CLI, SDK (`@botpress/sdk`), moving‑parts framework.
- **Advanced Options** – Plug‑your own LLM, Live‑Agent (HITL) bridges.
- **How‑to** – Register/unregister states, implement handlers, logging, custom actions, webhook handling.

---

## 7. Botpress APIs
- **Files API** – Upload, list, retrieve, update, delete, and index files (including semantic search).
- **Chat API** – Programmatic conversation handling (send/receive messages, session management).

---

## 8. Appendix
- **Safety** – Abuse‑prevention policies, brand‑safety framework (policy agent, RAG safety, LLM inspector, HITL escalation).
- **Exporting Data** – Raw conversations, conversation history, streaming analytics (hooks), compiled bot analytics.

---

## 9. Quick Navigation Map
```
Home → Getting Started → Dashboard (Workspace / Bot)
   ├─ Studio → Interface / Agents / Library / Hooks / Cards
   ├─ Cards → Send / Execute / Webchat / Flow Logic / AI
   ├─ Webchat → v2 (Embedded) / v1 (Deprecated)
   ├─ Integrations → Usage (pre‑built) / Building (custom)
   ├─ APIs → Files / Chat
   └─ Appendix → Safety / Exporting Data
```

*The documentation spans the entire bot lifecycle—design, deployment, interaction, extension, and governance—providing a complete, horizontally‑organized reference for developers.*


Input: {"body":{"messages":[{"content":"You are an expert research assistant specialized in answering questions using only the information provided in documents.\n\n# Task\nAnswer the user's question based ONLY on the information in the provided documents. You MUST cite your sources using line numbers.\n\n# Document Format\nDocuments are provided with line numbers:\n■001 | First line of text\n■002 | Second line of text\n■003 | Third line of text\n\n# Citation Format\nYou MUST include citations immediately after statements. Use these formats:\n- Single line: ■035\n- Range: ■005-010\n- Multiple: ■035■046■094\n\n# Response Format\n\nChoose ONE of these response types:\n\n**TYPE 1 - ANSWER** (Use this when you can answer the question)\n■answer\n[Your answer with inline citations. ■001-003 More text. ■015]\n■end■\n\n**TYPE 2 - AMBIGUOUS** (Use when the question has multiple valid interpretations)\n■ambiguous\n[Explain the ambiguity]\n■follow_up\n[Ask a clarifying question]\n■answer\n[First interpretation with citations ■001]\n■answer\n[Second interpretation with citations ■005]\n■end■\n\n**TYPE 3 - OUT OF TOPIC** (Use when question is completely unrelated to documents)\n■out_of_topic\n[Explain why it's unrelated]\n■end■\n\n**TYPE 4 - INVALID QUESTION** (Use when input is not a proper question)\n■invalid_question\n[Explain why it's invalid]\n■end■\n\n**TYPE 5 - MISSING KNOWLEDGE** (Use ONLY when documents lack specific details needed)\n■missing_knowledge\n[Explain what specific information is missing]\n■end■\n\n# Important Rules\n- PREFER answering when possible - only use missing_knowledge if truly no relevant info exists\n- ALWAYS cite sources with line numbers\n- Use ONLY information from the documents\n- Be precise and factual\n- Do NOT fabricate information\n- Do NOT mention \"According to the documents\" or similar phrases – just provide a high-quality answer with citations\n- Do not be too strict on the question format; assume high-level answers are acceptable unless the question clearly asks for very specific details or requests depth beyond the documents\n\n# Additional Instructions\nHere are some additional instructions to follow about how to answer the question:\nProvide a clear and concise answer based on the documents.","role":"system"},{"content":"<documents>\n■001 | {\n■002 |   \"id\": 21,\n■003 |   \"type\": \"entry\",\n■004 |   \"content\": \"Entry 21 contains generic information about topic 21.\",\n■005 |   \"metadata\": {\n■006 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■007 |     \"tags\": [\n■008 |       \"general\"\n■009 |     ]\n■010 |   }\n■011 | }\n■012 | {\n■013 |   \"id\": 22,\n■014 |   \"type\": \"entry\",\n■015 |   \"content\": \"Entry 22 contains generic information about topic 22.\",\n■016 |   \"metadata\": {\n■017 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■018 |     \"tags\": [\n■019 |       \"general\"\n■020 |     ]\n■021 |   }\n■022 | }\n■023 | {\n■024 |   \"id\": 23,\n■025 |   \"type\": \"entry\",\n■026 |   \"content\": \"Entry 23 contains generic information about topic 23.\",\n■027 |   \"metadata\": {\n■028 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■029 |     \"tags\": [\n■030 |       \"general\"\n■031 |     ]\n■032 |   }\n■033 | }\n■034 | {\n■035 |   \"id\": 24,\n■036 |   \"type\": \"entry\",\n■037 |   \"content\": \"Entry 24 contains generic information about topic 24.\",\n■038 |   \"metadata\": {\n■039 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■040 |     \"tags\": [\n■041 |       \"general\"\n■042 |     ]\n■043 |   }\n■044 | }\n■045 | {\n■046 |   \"id\": 25,\n■047 |   \"type\": \"entry\",\n■048 |   \"content\": \"Entry 25 contains generic information about topic 25.\",\n■049 |   \"metadata\": {\n■050 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■051 |     \"tags\": [\n■052 |       \"general\"\n■053 |     ]\n■054 |   }\n■055 | }\n■056 | {\n■057 |   \"id\": 26,\n■058 |   \"type\": \"entry\",\n■059 |   \"content\": \"Entry 26 contains generic information about topic 26.\",\n■060 |   \"metadata\": {\n■061 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■062 |     \"tags\": [\n■063 |       \"general\"\n■064 |     ]\n■065 |   }\n■066 | }\n■067 | {\n■068 |   \"id\": 27,\n■069 |   \"type\": \"entry\",\n■070 |   \"content\": \"Entry 27 contains generic information about topic 27.\",\n■071 |   \"metadata\": {\n■072 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■073 |     \"tags\": [\n■074 |       \"general\"\n■075 |     ]\n■076 |   }\n■077 | }\n■078 | {\n■079 |   \"id\": 28,\n■080 |   \"type\": \"entry\",\n■081 |   \"content\": \"Entry 28 contains generic information about topic 28.\",\n■082 |   \"metadata\": {\n■083 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■084 |     \"tags\": [\n■085 |       \"general\"\n■086 |     ]\n■087 |   }\n■088 | }\n■089 | {\n■090 |   \"id\": 29,\n■091 |   \"type\": \"entry\",\n■092 |   \"content\": \"Entry 29 contains generic information about topic 29.\",\n■093 |   \"metadata\": {\n■094 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■095 |     \"tags\": [\n■096 |       \"general\"\n■097 |     ]\n■098 |   }\n■099 | }\n■100 | {\n■101 |   \"id\": 30,\n■102 |   \"type\": \"entry\",\n■103 |   \"content\": \"Entry 30 contains generic information about topic 30.\",\n■104 |   \"metadata\": {\n■105 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■106 |     \"tags\": [\n■107 |       \"general\"\n■108 |     ]\n■109 |   }\n■110 | }\n■111 | {\n■112 |   \"id\": 31,\n■113 |   \"type\": \"entry\",\n■114 |   \"content\": \"Entry 31 contains generic information about topic 31.\",\n■115 |   \"metadata\": {\n■116 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■117 |     \"tags\": [\n■118 |       \"general\"\n■119 |     ]\n■120 |   }\n■121 | }\n■122 | {\n■123 |   \"id\": 32,\n■124 |   \"type\": \"entry\",\n■125 |   \"content\": \"Entry 32 contains generic information about topic 32.\",\n■126 |   \"metadata\": {\n■127 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■128 |     \"tags\": [\n■129 |       \"general\"\n■130 |     ]\n■131 |   }\n■132 | }\n■133 | {\n■134 |   \"id\": 33,\n■135 |   \"type\": \"entry\",\n■136 |   \"content\": \"Entry 33 contains generic information about topic 33.\",\n■137 |   \"metadata\": {\n■138 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■139 |     \"tags\": [\n■140 |       \"general\"\n■141 |     ]\n■142 |   }\n■143 | }\n■144 | {\n■145 |   \"id\": 34,\n■146 |   \"type\": \"entry\",\n■147 |   \"content\": \"Entry 34 contains generic information about topic 34.\",\n■148 |   \"metadata\": {\n■149 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■150 |     \"tags\": [\n■151 |       \"general\"\n■152 |     ]\n■153 |   }\n■154 | }\n■155 | {\n■156 |   \"id\": 35,\n■157 |   \"type\": \"entry\",\n■158 |   \"content\": \"Entry 35 contains generic information about topic 35.\",\n■159 |   \"metadata\": {\n■160 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■161 |     \"tags\": [\n■162 |       \"general\"\n■163 |     ]\n■164 |   }\n■165 | }\n■166 | {\n■167 |   \"id\": 36,\n■168 |   \"type\": \"entry\",\n■169 |   \"content\": \"Entry 36 contains generic information about topic 36.\",\n■170 |   \"metadata\": {\n■171 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■172 |     \"tags\": [\n■173 |       \"general\"\n■174 |     ]\n■175 |   }\n■176 | }\n■177 | {\n■178 |   \"id\": 37,\n■179 |   \"type\": \"entry\",\n■180 |   \"content\": \"Entry 37 contains generic information about topic 37.\",\n■181 |   \"metadata\": {\n■182 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■183 |     \"tags\": [\n■184 |       \"general\"\n■185 |     ]\n■186 |   }\n■187 | }\n■188 | {\n■189 |   \"id\": 38,\n■190 |   \"type\": \"entry\",\n■191 |   \"content\": \"Entry 38 contains generic information about topic 38.\",\n■192 |   \"metadata\": {\n■193 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■194 |     \"tags\": [\n■195 |       \"general\"\n■196 |     ]\n■197 |   }\n■198 | }\n■199 | {\n■200 |   \"id\": 39,\n■201 |   \"type\": \"entry\",\n■202 |   \"content\": \"Entry 39 contains generic information about topic 39.\",\n■203 |   \"metadata\": {\n■204 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■205 |     \"tags\": [\n■206 |       \"general\"\n■207 |     ]\n■208 |   }\n■209 | }\n■210 | {\n■211 |   \"id\": 40,\n■212 |   \"type\": \"entry\",\n■213 |   \"content\": \"Entry 40 contains generic information about topic 40.\",\n■214 |   \"metadata\": {\n■215 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■216 |     \"tags\": [\n■217 |       \"general\"\n■218 |     ]\n■219 |   }\n■220 | }\n■221 | {\n■222 |   \"id\": 41,\n■223 |   \"type\": \"entry\",\n■224 |   \"content\": \"Entry 41 contains generic information about topic 41.\",\n■225 |   \"metadata\": {\n■226 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■227 |     \"tags\": [\n■228 |       \"general\"\n■229 |     ]\n■230 |   }\n■231 | }\n</documents>\n\nPlease answer the below question using the format specified above.\nQuestion to answer: \"What is Kubernetes?\"","role":"user","type":"text"}],"meta":{"integrationName":"zai","promptCategory":"zai:zai.answer","promptSource":"zai:zai.answer:default"},"model":"fast","reasoningEffort":"none","signal":{},"stopSequences":["■end■"]},"method":"POST","url":"https://api.botpress.cloud/v2/cognitive/generate-text"}

Output:
■missing_knowledge
The provided documents only contain generic entries about topics numbered 21 to 41 and do not include any information describing what Kubernetes is. ■end

Reasoning effort "none" is not supported by the "gpt-oss-120b" model, using "low" effort instead


Input: {"body":{"messages":[{"content":"You are an expert research assistant specialized in answering questions using only the information provided in documents.\n\n# Task\nAnswer the user's question based ONLY on the information in the provided documents. You MUST cite your sources using line numbers.\n\n# Document Format\nDocuments are provided with line numbers:\n■001 | First line of text\n■002 | Second line of text\n■003 | Third line of text\n\n# Citation Format\nYou MUST include citations immediately after statements. Use these formats:\n- Single line: ■035\n- Range: ■005-010\n- Multiple: ■035■046■094\n\n# Response Format\n\nChoose ONE of these response types:\n\n**TYPE 1 - ANSWER** (Use this when you can answer the question)\n■answer\n[Your answer with inline citations. ■001-003 More text. ■015]\n■end■\n\n**TYPE 2 - AMBIGUOUS** (Use when the question has multiple valid interpretations)\n■ambiguous\n[Explain the ambiguity]\n■follow_up\n[Ask a clarifying question]\n■answer\n[First interpretation with citations ■001]\n■answer\n[Second interpretation with citations ■005]\n■end■\n\n**TYPE 3 - OUT OF TOPIC** (Use when question is completely unrelated to documents)\n■out_of_topic\n[Explain why it's unrelated]\n■end■\n\n**TYPE 4 - INVALID QUESTION** (Use when input is not a proper question)\n■invalid_question\n[Explain why it's invalid]\n■end■\n\n**TYPE 5 - MISSING KNOWLEDGE** (Use ONLY when documents lack specific details needed)\n■missing_knowledge\n[Explain what specific information is missing]\n■end■\n\n# Important Rules\n- PREFER answering when possible - only use missing_knowledge if truly no relevant info exists\n- ALWAYS cite sources with line numbers\n- Use ONLY information from the documents\n- Be precise and factual\n- Do NOT fabricate information\n- Do NOT mention \"According to the documents\" or similar phrases – just provide a high-quality answer with citations\n- Do not be too strict on the question format; assume high-level answers are acceptable unless the question clearly asks for very specific details or requests depth beyond the documents\n\n# Additional Instructions\nHere are some additional instructions to follow about how to answer the question:\nProvide a clear and concise answer based on the documents.","role":"system"},{"content":"<documents>\n■001 | {\n■002 |   \"id\": 42,\n■003 |   \"type\": \"entry\",\n■004 |   \"content\": \"Entry 42 contains generic information about topic 42.\",\n■005 |   \"metadata\": {\n■006 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■007 |     \"tags\": [\n■008 |       \"general\"\n■009 |     ]\n■010 |   }\n■011 | }\n■012 | {\n■013 |   \"id\": 43,\n■014 |   \"type\": \"entry\",\n■015 |   \"content\": \"Entry 43 contains generic information about topic 43.\",\n■016 |   \"metadata\": {\n■017 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■018 |     \"tags\": [\n■019 |       \"general\"\n■020 |     ]\n■021 |   }\n■022 | }\n■023 | {\n■024 |   \"id\": 44,\n■025 |   \"type\": \"entry\",\n■026 |   \"content\": \"Entry 44 contains generic information about topic 44.\",\n■027 |   \"metadata\": {\n■028 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■029 |     \"tags\": [\n■030 |       \"general\"\n■031 |     ]\n■032 |   }\n■033 | }\n■034 | {\n■035 |   \"id\": 45,\n■036 |   \"type\": \"entry\",\n■037 |   \"content\": \"Entry 45 contains generic information about topic 45.\",\n■038 |   \"metadata\": {\n■039 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■040 |     \"tags\": [\n■041 |       \"general\"\n■042 |     ]\n■043 |   }\n■044 | }\n■045 | {\n■046 |   \"id\": 46,\n■047 |   \"type\": \"entry\",\n■048 |   \"content\": \"Entry 46 contains generic information about topic 46.\",\n■049 |   \"metadata\": {\n■050 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■051 |     \"tags\": [\n■052 |       \"general\"\n■053 |     ]\n■054 |   }\n■055 | }\n■056 | {\n■057 |   \"id\": 47,\n■058 |   \"type\": \"entry\",\n■059 |   \"content\": \"Entry 47 contains generic information about topic 47.\",\n■060 |   \"metadata\": {\n■061 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■062 |     \"tags\": [\n■063 |       \"general\"\n■064 |     ]\n■065 |   }\n■066 | }\n■067 | {\n■068 |   \"id\": 48,\n■069 |   \"type\": \"entry\",\n■070 |   \"content\": \"Entry 48 contains generic information about topic 48.\",\n■071 |   \"metadata\": {\n■072 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■073 |     \"tags\": [\n■074 |       \"general\"\n■075 |     ]\n■076 |   }\n■077 | }\n■078 | {\n■079 |   \"id\": 49,\n■080 |   \"type\": \"entry\",\n■081 |   \"content\": \"Entry 49 contains generic information about topic 49.\",\n■082 |   \"metadata\": {\n■083 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■084 |     \"tags\": [\n■085 |       \"general\"\n■086 |     ]\n■087 |   }\n■088 | }\n■089 | {\n■090 |   \"id\": 50,\n■091 |   \"type\": \"important\",\n■092 |   \"content\": \"Kubernetes automates deployment, scaling, and management of containerized applications.\",\n■093 |   \"metadata\": {\n■094 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■095 |     \"tags\": [\n■096 |       \"kubernetes\",\n■097 |       \"containers\"\n■098 |     ]\n■099 |   }\n■100 | }\n■101 | {\n■102 |   \"id\": 51,\n■103 |   \"type\": \"entry\",\n■104 |   \"content\": \"Entry 51 contains generic information about topic 51.\",\n■105 |   \"metadata\": {\n■106 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■107 |     \"tags\": [\n■108 |       \"general\"\n■109 |     ]\n■110 |   }\n■111 | }\n■112 | {\n■113 |   \"id\": 52,\n■114 |   \"type\": \"entry\",\n■115 |   \"content\": \"Entry 52 contains generic information about topic 52.\",\n■116 |   \"metadata\": {\n■117 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■118 |     \"tags\": [\n■119 |       \"general\"\n■120 |     ]\n■121 |   }\n■122 | }\n■123 | {\n■124 |   \"id\": 53,\n■125 |   \"type\": \"entry\",\n■126 |   \"content\": \"Entry 53 contains generic information about topic 53.\",\n■127 |   \"metadata\": {\n■128 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■129 |     \"tags\": [\n■130 |       \"general\"\n■131 |     ]\n■132 |   }\n■133 | }\n■134 | {\n■135 |   \"id\": 54,\n■136 |   \"type\": \"entry\",\n■137 |   \"content\": \"Entry 54 contains generic information about topic 54.\",\n■138 |   \"metadata\": {\n■139 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■140 |     \"tags\": [\n■141 |       \"general\"\n■142 |     ]\n■143 |   }\n■144 | }\n■145 | {\n■146 |   \"id\": 55,\n■147 |   \"type\": \"entry\",\n■148 |   \"content\": \"Entry 55 contains generic information about topic 55.\",\n■149 |   \"metadata\": {\n■150 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■151 |     \"tags\": [\n■152 |       \"general\"\n■153 |     ]\n■154 |   }\n■155 | }\n■156 | {\n■157 |   \"id\": 56,\n■158 |   \"type\": \"entry\",\n■159 |   \"content\": \"Entry 56 contains generic information about topic 56.\",\n■160 |   \"metadata\": {\n■161 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■162 |     \"tags\": [\n■163 |       \"general\"\n■164 |     ]\n■165 |   }\n■166 | }\n■167 | {\n■168 |   \"id\": 57,\n■169 |   \"type\": \"entry\",\n■170 |   \"content\": \"Entry 57 contains generic information about topic 57.\",\n■171 |   \"metadata\": {\n■172 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■173 |     \"tags\": [\n■174 |       \"general\"\n■175 |     ]\n■176 |   }\n■177 | }\n■178 | {\n■179 |   \"id\": 58,\n■180 |   \"type\": \"entry\",\n■181 |   \"content\": \"Entry 58 contains generic information about topic 58.\",\n■182 |   \"metadata\": {\n■183 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■184 |     \"tags\": [\n■185 |       \"general\"\n■186 |     ]\n■187 |   }\n■188 | }\n■189 | {\n■190 |   \"id\": 59,\n■191 |   \"type\": \"entry\",\n■192 |   \"content\": \"Entry 59 contains generic information about topic 59.\",\n■193 |   \"metadata\": {\n■194 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■195 |     \"tags\": [\n■196 |       \"general\"\n■197 |     ]\n■198 |   }\n■199 | }\n■200 | {\n■201 |   \"id\": 60,\n■202 |   \"type\": \"entry\",\n■203 |   \"content\": \"Entry 60 contains generic information about topic 60.\",\n■204 |   \"metadata\": {\n■205 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■206 |     \"tags\": [\n■207 |       \"general\"\n■208 |     ]\n■209 |   }\n■210 | }\n■211 | {\n■212 |   \"id\": 61,\n■213 |   \"type\": \"entry\",\n■214 |   \"content\": \"Entry 61 contains generic information about topic 61.\",\n■215 |   \"metadata\": {\n■216 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■217 |     \"tags\": [\n■218 |       \"general\"\n■219 |     ]\n■220 |   }\n■221 | }\n■222 | {\n■223 |   \"id\": 62,\n■224 |   \"type\": \"entry\",\n■225 |   \"content\": \"Entry 62 contains generic information about topic 62.\",\n■226 |   \"metadata\": {\n■227 |     \"created\": \"2025-11-06T21:34:13.840Z\",\n■228 |     \"tags\": [\n■229 |       \"general\"\n■230 |     ]\n■231 |   }\n■232 | }\n</documents>\n\nPlease answer the below question using the format specified above.\nQuestion to answer: \"What is Kubernetes?\"","role":"user","type":"text"}],"meta":{"integrationName":"zai","promptCategory":"zai:zai.answer","promptSource":"zai:zai.answer:default"},"model":"fast","reasoningEffort":"none","signal":{},"stopSequences":["■end■"]},"method":"POST","url":"https://api.botpress.cloud/v2/cognitive/generate-text"}

Output:
■answer
Kubernetes is a system that automates the deployment, scaling, and management of containerized applications. ■092■093

Reasoning effort "none" is not supported by the "gpt-oss-120b" model, using "low" effort instead