Botpress Studio

The Botpress SDK is a framework for developing extensible components within Botpress. It supports four primary component types:

1. Integrations: Connect bots to external services (e.g., Slack, WhatsApp, Telegram) to send/receive messages, manipulate external data, or trigger bot events based on external actions.
2. Interfaces: Contracts that define expected behaviors (events and actions) that integrations must implement to support specific features (e.g., Typing Indicators).
3. Bots (Bots-as-code): Allows developers to define bots using code instead of the Botpress Studio web interface. This is recommended for experienced developers needing tighter version control integration.
4. Plugins: Modular, reusable components that extend bot functionality and can be shared across multiple bots. Currently, only official Botpress plugins are available for installation via Studio.

Tables function as a local database within a bot's environment, providing structured storage for data that must persist across multiple sessions (e.g., user profiles, transaction histories).

Plan Limits (Free Plan):

• Maximum of 10 tables.
• Maximum of 20 columns per table (Hard limit).
• Maximum of 10,000 rows.

Row Factors and Storage: Each table has a 'row factor' that determines the storage limit per row. The default is 1, allowing 4KB per row. Increasing the row factor increases the storage limit (e.g., a factor of 3 allows 12KB per row) but causes each row to count more against the total row limit (e.g., one row with factor 3 counts as three rows).

Botpress provides several specialized APIs to interact with its platform. Most APIs are hosted at https://api.botpress.cloud, with the exception of the Chat API.

• Chat API: Used to interact with deployed bots via HTTP requests. Requires the Chat Integration to be installed.
• Admin API: Used to manage workspaces, bots, integrations, logs, analytics, and collaborators. Generally, any feature in the Botpress Dashboard is accessible here.
• Files API: Used to manage uploaded files for knowledge bases, media hosting (images, videos, documents), or bot/integration storage.
• Tables API: Used to manage structured data tables for storing user data, labeling, and information extraction.
• Runtime API: Used by bots and integrations to handle messages, events, and requests. Authentication is performed as a bot or integration (e.g., using a Personal Access Token/PAT).

Viber agents use different capabilities depending on whether the goal is communication or action.

• Channels: Used for where people talk to the published agent (found in Deploy > Channels).
• Integrations: Used for actions in another service, such as creating a CRM record (found in Build > Tools).
• HTTP Requests: Used for custom requests to external HTTP APIs (found in Build > Tools).
• MCP servers: Used for tools exposed by a Model Context Protocol server (found in Build > Tools).
• Credentials: Secrets used to authorize any of the above connections.

Zai is a utility library for structured LLM operations available via adk.zai in the Botpress ADK. It replaces raw prompting with typed methods that handle prompting, parsing, and validation automatically.

Common operations include:

• Extraction: extract() for pulling structured data from text.
• Classification & Validation: check() (Boolean), label() (multiple labels), filter() (array filtering), sort() (natural language criteria), rate() (1-5 scale), and group() (categorization).
• Generation: text() (general generation), rewrite() (transformation), summarize() (summarization), answer() (questions with citations), and patch() (surgical file edits).