Reference

Get Account

Retrieve your authenticated account details including profile information, subscription status, and account settings from Botpress.

Get Account Preference

Retrieves a specific account preference setting by its key, allowing you to access stored configuration values for your Botpress account. This helps you manage and verify account-level settings that control your chatbot's behavior and features.

Set Account Preference

Updates or creates settings for your Botpress account to customize how it handles payments and transactions. This allows you to configure account-specific preferences that affect your payment processing behavior.

Update Account

Modify your Botpress account details such as display name and profile picture to keep your account information current and professional.

LIST_ACTION_RUNS

Retrieve the execution history of actions performed by your bot's integration, with optional filtering by date range and pagination support to manage large result sets.

BOTPRESS_CREATE_BOT

Creates a new bot in your Botpress workspace with custom configurations like name, tags, and integrations. This allows you to quickly set up automated conversational agents for different business needs without manual setup.

BOTPRESS_UPDATE_ADMIN_BOTS

Modify an existing bot's configuration, tags, code, or properties in your Botpress workspace without affecting other bots or settings.

BOTPRESS_CREATE_CONVERSATION

Initiates a new conversation thread in Botpress, allowing you to start fresh interactions with customers or users. This is essential for organizing separate discussion topics and tracking distinct customer inquiries.

LIST_CONVERSATIONS

Retrieve all chat conversations with your customers to review interactions, track engagement, and analyze communication history. This helps you understand customer needs and monitor bot performance across all conversations.

Delete File

Permanently removes a file from your Botpress bot's storage to free up space and keep your bot's file system clean. This is useful for deleting outdated documents, conversation transcripts, or temporary files that are no longer needed.

LIST_FILE_TAG_VALUES

Retrieve all values assigned to a specific file tag across your bot's files, helping you organize and filter files by custom metadata. Useful for understanding what tag values exist in your system before using them for file organization or filtering.

LIST_FILE_TAGS

Retrieves all tags applied across your bot files to help organize and categorize content. This is useful when you need to see what tags exist in your system or display them to users.

Check Handle Availability

Verifies whether a specific workspace handle is available in Botpress before creation or renaming, helping you secure your desired workspace name without conflicts.

List Integrations

Retrieve a list of all available integrations in your Botpress workspace with filtering and sorting options to find exactly what you need. Use this to discover, search for, and organize integrations by type, status, or other criteria.

BOTPRESS_CREATE_ADMIN_INTEGRATION

Set up a new integration in your Botpress workspace with custom configuration, allowing you to connect external services, automate workflows, and extend your chatbot's capabilities without manual setup.

BOTPRESS_VALIDATE_INTEGRATION_UPDATE

Verifies that your Botpress integration update request has valid parameters and is ready to be applied, preventing failed updates and configuration errors.

Delete Integration Shareable ID

Removes a shareable ID from a Botpress integration, allowing you to revoke public access to that integration's connection point. This is useful when you need to disable or reset how users interact with a specific bot integration.

Get Integration

Retrieve detailed information about a specific Botpress integration including its configuration, actions, events, and channels to understand its capabilities and current setup.

Get Public Integration

Retrieve detailed information about a public integration from the Botpress hub, including its available actions, events, and channels. This helps you verify integration capabilities before implementing them in your chatbot.

Get Public Integration By ID

Retrieve comprehensive details about a Botpress integration including its configuration, supported channels, available actions, and events. Use this to understand integration capabilities and settings before implementing or troubleshooting integrations in your chatbot workflows.

LIST_HUB_INTEGRATIONS

Browse and discover available integrations in the Botpress hub to find tools that connect your chatbot to other business applications and services. Use this to search for specific integration types or filter by verification status and features.

LIST_INTEGRATION_API_KEYS

Retrieve all API keys associated with a specific integration in your workspace, helping you manage and audit which keys are currently active for that integration.

Request Integration Verification

Submit a Botpress integration for verification to make it publicly available and ready for other users to install. This ensures your integration meets platform standards before wider distribution.

Get Public Interface

Retrieve interface specifications and schemas from the Botpress Hub to understand how to interact with specific integrations and their data structures.

Get Public Interface by ID

Retrieve detailed information about a specific public interface from the Botpress Hub, including its available actions, events, channels, and entities. This helps you understand what functionality a particular interface offers before integrating it into your chatbot.

List Public Interfaces

Retrieve all available public interfaces from the Botpress Hub that can be integrated into your chatbots, helping you discover integration options without manual browsing.

BOTPRESS_CHARGE_WORKSPACE_UNPAID_INVOICES

Process outstanding invoices for your Botpress workspace to collect unpaid amounts and maintain current billing status. Use this when you need to manually trigger payment collection for invoices that haven't been automatically processed.

Get Upcoming Invoice

Retrieve a preview of your workspace's next billing charges so you can anticipate costs and plan your budget accordingly.

List Workspace Invoices

Retrieve all invoices associated with your Botpress workspace to access your complete billing history and payment records. This helps you track expenses, verify charges, and manage your workspace's financial documentation.

LIST_BOT_ISSUES

Retrieves all errors and configuration problems associated with your bot so you can identify and fix issues affecting its performance and user experience.

LIST_KNOWLEDGE_BASES

Retrieve all knowledge bases associated with your bot, with optional filtering by tags and pagination support to manage large collections efficiently.

Delete Knowledge Base

Permanently removes a knowledge base from your Botpress bot when it's no longer needed. This is useful for cleaning up outdated information sources and maintaining an organized bot setup.

BOTPRESS_SEND_MESSAGE

Send messages directly to users within Botpress conversations to deliver notifications, responses, or updates in real-time. This enables your bot to proactively communicate with customers or team members without waiting for them to initiate contact.

Get Dereferenced Public Plugin By ID

Retrieves detailed information about a public plugin including all its connected integrations and fully resolved interface data, making it ready to use immediately without additional lookups.

Get Public Plugin

Retrieve detailed information about a public plugin available in Botpress Hub, including its configuration, dependencies, and capabilities. Use this to evaluate and understand plugins before adding them to your chatbot.

Get Public Plugin By ID

Retrieve detailed information about a public plugin using its ID, including its configuration, available actions, events, and metadata. This helps you understand a plugin's capabilities before integrating it into your chatbot.

Get Public Plugin Code

Retrieve the source code for any public plugin available on Botpress Hub, allowing you to examine implementation details and understand how plugins work before using them in your chatbot.

List Plugins

Retrieve all available plugins in your Botpress workspace to discover what integrations and features you can add to your chatbots. This helps you find the right tools to extend your bot's capabilities without manual searching.

LIST_PUBLIC_PLUGINS

Retrieves all available public plugins from the Botpress hub that you can install to extend your chatbot's functionality. Use this to discover and evaluate plugins that match your business needs.

Get All Workspace Quota Completion

Retrieve the quota usage completion rates across all your workspaces in one call, helping you monitor resource consumption and identify which workspaces are approaching their limits.

Get Workspace Quota

Retrieve your workspace's resource limits and current usage levels for a specific metric. Use this to monitor whether you're approaching capacity limits or need to upgrade your plan.

BOTPRESS_RUN_VRL

Execute custom data transformation scripts to process, validate, or manipulate information flowing through your Botpress chatbot. This enables dynamic data handling without requiring code changes to your bot's core logic.

Get Table Row

Retrieve a specific row of data from a Botpress table by its unique identifier to access detailed information stored in your database.

Break Down Workspace Usage By Bot

Get detailed usage metrics for each bot in your workspace, including invocation calls, storage usage, and AI spending costs. This helps you understand which bots are driving your expenses and resource consumption.

LIST_USAGE_HISTORY

Retrieve detailed usage history for your bot to track resource consumption and monitor how your workspace is utilizing API calls, AI credits, and other metered services over time.

BOTPRESS_UPDATE_WORKFLOW

Modify an existing workflow in Botpress by updating its parameters, such as status, output data, tags, or failure information without affecting unchanged fields.

Get Workspace

Retrieve detailed information about your Botpress workspace including plan type, number of bots, owner details, billing information, and configuration settings.

BOTPRESS_CREATE_ADMIN_WORKSPACE

Creates a new workspace in Botpress to organize and manage your bots and team resources. Use this when you need to set up a separate environment for different projects, clients, or business units.

Delete Admin Workspace

Permanently removes a Botpress workspace and all its associated bots and data when you no longer need it. This helps you clean up your admin account and focus on active projects.

LIST_PUBLIC_WORKSPACES

Retrieve all publicly available workspaces to discover and explore shared collaboration spaces. This helps you find relevant workspaces for your team or bot deployments without needing direct invitations.

LIST_WORKSPACES

Retrieve all Botpress workspaces you have access to, including details about each workspace's bots and plan type. This helps you quickly find and manage multiple workspace environments in one view.

Set Workspace Preference

Store or update custom settings and preferences for your Botpress workspace, such as language, timezone, notification defaults, or payment processing options. This lets you configure workspace behavior without manual setup each time.

UPDATE_ADMIN_WORKSPACE

Modify your Botpress workspace settings such as name, description, contact details, and visibility to keep your bot's public profile up-to-date and aligned with your brand identity.