botpress · adkah · Jan 15, 2026 · Jan 15, 2026
@@ -1,3 +1,7 @@
+---
+title: Conversations
+---
+
 Conversations are the primary way your agent handles user messages. Each conversation handler defines how your agent responds to messages from specific channels.
 
 ## Creating a conversation

@@ -1,3 +1,8 @@
+---
+title: Steps
+---
+
+
 This page contains a full reference for the [`step` function](/adk/concepts/workflows/overview#steps).
 
 ```typescript

@@ -1,3 +1,7 @@
+---
+title: Introduction to the ADK
+---
+
 <Panel>
   <ResponseExample>
     ```ts Basic agent

@@ -1,3 +1,7 @@
+---
+title: Project structure
+---
+
 ADK projects follow a consistent structure that organizes your agent's code, configuration, and dependencies.
 
 ## Directory structure

@@ -1,3 +1,7 @@
+---
+title: Quickstart
+---
+
 This guide walks you through installing the ADK and creating your first agent project.
 
 <Info>

@@ -1,3 +1,7 @@
+---
+title: Concepts
+---
+
 The **Admin API** is used to manage the surrounding infrastructure of the bots. It handles accounts, workspaces, users, quotas, billing, and other administrative functions.
 
 ## Account

@@ -1,3 +1,7 @@
+---
+title: Getting started
+---
+
 import adminApiPayloadSize from '/snippets/api-payload-limits.mdx'
 
 The Admin API allows administrators to manage users, settings, and logs within the platform. This guide will help you quickly get up and running with the API.

@@ -1,3 +1,7 @@
+---
+title: Authentication
+---
+
 You can authenticate to Botpress's API (`api.botpress.cloud`) as a user, a bot, or an integration. To do so, you'll need to use a token.
 
 <Tip>If you are looking to use the Webchat API or the Chat API to talk to your bot, please refer to the [Chat API documentation](/api-reference/chat-api/introduction) and [Webchat documentation](/webchat/get-started/introduction).</Tip>

@@ -1,3 +1,7 @@
+---
+title: Errors
+---
+
 ## Error Response Types
 
 When an error occurs while calling an API endpoint, the response will return the appropriate HTTP status code as indicated below. The following table outlines possible error type and its corresponding description and status.

@@ -1,3 +1,7 @@
+---
+title: Getting started
+---
+
 import filesApiPayloadSize from "/snippets/api-payload-limits.mdx"
 
 The Files API allows you to upload, download, and manage files and searchable documents for your bots and integrations in Botpress Cloud.

@@ -1,3 +1,7 @@
+---
+title: Index and search files
+---
+
 ## Creating an indexed file
 
 If you need to index a file for semantic search just pass the `index: true` parameter when creating the file.

@@ -1,3 +1,7 @@
+---
+title: Manage files
+---
+
 ## Getting the file's metadata
 
 To get the details of a file you can use the [Get File](/api-reference/files-api/how-tos/manage-files#getting-the-file’s-metadata) API endpoint.

@@ -1,3 +1,7 @@
+---
+title: Introduction
+---
+
 At Botpress, we love APIs. Every API we develop—whether public or private—is carefully designed with a strong focus on coherence and consistency. API design is at the core of our development process.
 
 Botpress is also a very big and complex system, and there isn't a single API that does everything. Instead, we provide multiple APIs, each tailored to specific functionalities. Below is a comprehensive list of all publicly available APIs in Botpress. Each API has dedicated documentation section.

@@ -1,3 +1,7 @@
+---
+title: Pagination
+---
+
 Our APIs return paginated results. Our paging is based on a cursor-based pagination system, which means that the API returns a set of results and a cursor (`nextToken`) that you can use to retrieve the next set of results. You can use this cursor in 2 ways:
 
 ## 1. Pagination with API Query Parameters

@@ -1,3 +1,7 @@
+---
+title: Rate limiting
+---
+
 Our APIs are protected using a sliding window rate limiter. This means that exceeding the allowed number of requests per time window will result in a `429 Too Many Requests` (rate-limited) response.
 
 The rate limiter returns for each request the following headers:

@@ -1,3 +1,7 @@
+---
+title: Desk
+---
+
 Desk is a **customer experience workspace for human-AI teams**. It combines a familiar interface with powerful AI-assisted tools, like:
 
 - Suggested answers to customer messages

@@ -1,3 +1,7 @@
+---
+title: Configure your workspace
+---
+
 In Botpress, your workspace is the environment where you organize, manage, and collaborate on your agent projects.
 
 Each Workspace can contain multiple agents, so you can keep them organized by customer, department, or use case. Within a workspace, you can manage permissions, usage, billing, and more.

@@ -1,4 +1,5 @@
 ---
+title: Attio
 description: Add a bot to Attio using the official integration.
 icon: '/integrations/integration-guides/assets/icons/attio.png'
 ---

@@ -1,4 +1,5 @@
 ---
+title: Gmail
 icon: '/integrations/integration-guides/assets/icons/gmail.svg'
 ---
 

@@ -1,4 +1,5 @@
 ---
+title: Instagram
 description: Add your bot to Instagram using the official integration.
 icon: '/integrations/integration-guides/assets/icons/instagram.svg'
 ---

@@ -1,4 +1,5 @@
 ---
+title: Klaviyo
 description: Add a bot to Klaviyo using the official integration.
 icon: '/integrations/integration-guides/assets/icons/klaviyo.png'
 ---

@@ -1,4 +1,5 @@
 ---
+title: Pipedrive
 description: Add a bot to Pipedrive using the official integration.
 icon: '/integrations/integration-guides/assets/icons/pipedrive.svg'
 ---

@@ -1,4 +1,5 @@
 ---
+title: Slack
 description: Add a bot to Slack using the official integration.
 icon: '/integrations/integration-guides/assets/icons/slack.svg'
 ---

@@ -1,3 +1,7 @@
+---
+title: Installation
+---
+
 To get started, install the Botpress CLI globally on your machine. The CLI includes the Botpress SDK and other useful packages for developing with Botpress.
 
 Run the following command in your terminal:

@@ -1,3 +1,7 @@
+---
+title: Set inactivity timeout
+---
+
 You can use the Set Inactivity Timeout Card to **override the default inactivity timeout** configured in your [Bot Settings](/studio/concepts/bot-settings#inactivity-timeout).
 
 <Tip>

@@ -1,3 +1,7 @@
+---
+title: Tables
+---
+
 You can use table Cards to perform operations on data you have stored in a table. This page contains a list of available table Cards.
 
 <Note>

@@ -1,4 +1,5 @@
 ---
+title: Triggers
 icon: play
 ---
 

@@ -1,3 +1,7 @@
+---
+title: Workflows
+---
+
 import { GoodToKnow } from '/snippets/tutorial/good-to-know.mdx'
 
 So far, we've only had our bot generate responses using AI. In practice, though, you might run into situations where you want your bot to perform some hard-coded logic.

@@ -1,3 +1,7 @@
+---
+title: Adding knowledge
+---
+
 Now that our bot has a custom prompt, let's try asking it a question:
 
 <Frame>

@@ -1,3 +1,7 @@
+---
+title: Prompting
+---
+
 In Botpress, an AI agent is a bot that follows a *prompt* (instructions) to respond to users.
 
 You can view your bot's prompt in Studio. After skipping the initial setup, select **Edit in Studio**. This opens Studio in a new tab—you'll see the prompt under **<Icon icon="list-checks"/> Instructions** at the top of the page. It should look something like this:

@@ -1,3 +1,7 @@
+---
+title: Assigning a value
+---
+
 import { GoodToKnow } from '/snippets/tutorial/good-to-know.mdx'
 
 A newly-created variable is like an empty box—you need put something inside it before you can use it. This is called *assigning a value* to your variable.

@@ -1,3 +1,7 @@
+---
+title: Scoping variables
+---
+
 import { GoodToKnow } from '/snippets/tutorial/good-to-know.mdx'
 
 Every variable has a *scope* that determines where and when your bot can access it.

@@ -1,3 +1,7 @@
+---
+title: Variables
+---
+
 Sometimes, it's useful for your bot to remember some information—for example, about a specific user or conversation.
 
 You can do this using *variables*. A variable is a container that lets you store information from somewhere in Botpress Studio and reuse it somewhere else.

@@ -1,4 +1,5 @@
 ---
+title: Introduction
 icon: chef-hat
 ---
 

@@ -1,3 +1,7 @@
+---
+title: Composer
+---
+
 The `Composer` component is where the user writes messages before sending them to the bot. It provides a text area for input, file uploads, and a speech-to-text option.
 
 <Panel>
@@ -85,4 +89,4 @@ The `Composer` component is where the user writes messages before sending them t
   type="Ref<HTMLTextAreaElement>"
 >
   Provides a ref to the text input element. Useful for focusing or manipulating the input programmatically.
-</ResponseField>
+</ResponseField>
@@ -1,3 +1,7 @@
+---
+title: Container
+---
+
 The `Container` wraps the core Webchat interface.
 It manages:
 

@@ -1,3 +1,7 @@
+---
+title: Header
+---
+
 The `Header` component sits at the top of the Webchat UI. It displays the bot’s name, avatar, and description. It also provides access to key actions like restarting the conversation or closing the chat window.
 
 <Panel>
@@ -141,4 +145,4 @@ The `Header` component sits at the top of the Webchat UI. It displays the bot’
       </ResponseField>
 
     </Expandable>
-</ResponseField>
+</ResponseField>
@@ -1,3 +1,7 @@
+---
+title: Webchat
+---
+
 The `Webchat` component is a batteries-included implementation of the Webchat window. It contains most of what you'd expect when [injecting Webchat](/webchat/get-started/quick-start).
 
 <Panel>