Connect Botpress to your AI agent
Botpress is an open-source platform for building, deploying, and managing chatbots.
We set up the connection using your own Botpress account, with keys you control, and keep it running. Your agent picks it up and starts doing the work.
Actions
What your agent can do in Botpress
Each one is a real action the agent can take on its own, the same things a person clicking around Botpress could do. Read-only by default; write actions are confirmed against your policy.
- Break Down Workspace Usage By Bot Tool to break down workspace usage by bot. Use this to get detailed usage metrics for individual bots within a workspace, such as invocation calls, storage count, or AI spend.
- Botpress charge workspace unpaid invoices Tool to charge unpaid invoices for a specific Botpress workspace. Use when you need to manually trigger payment for outstanding workspace invoices. Returns details of successfully charged invoices and any that failed.
- Check Handle Availability Tool to check if a workspace handle is available in Botpress. Use when creating or renaming a workspace to verify the handle is not already taken. Returns availability status and suggestions for alternative handles if u…
- Botpress create admin integration Tool to create a new integration in a Botpress workspace via the Admin API. Use when you need to provision a new integration with configuration including name, version, code, actions, events, and channels.
- Botpress create admin workspace Tool to create a new workspace in Botpress via the Admin API. Use when you need to provision a new workspace for organizing bots and managing team resources. The workspace will be created under the authenticated account…
- Botpress create bot Tool to create a new bot in a Botpress workspace via the Admin API. Use when you need to provision a new bot with optional configuration including name, code, tags, events, states, and integrations.
- Botpress create conversation Tool to create a new conversation in Botpress via the Runtime API. Use when you need to initiate a new conversation thread. The required tags must be provided according to the specific integration being used.
- Delete Admin Workspace Tool to permanently delete a workspace from Botpress admin. Use this to remove workspaces that are no longer needed. The deletion is irreversible and removes all associated bots and data.
- Delete File Permanently deletes a file from a Botpress bot's storage by its file ID. Use this tool to remove files that are no longer needed. The deletion is irreversible. Requires a valid file ID and the bot ID that owns the file.
- Delete Integration Shareable ID Tool to delete a shareable ID for an integration installed in a Botpress bot. Use when you need to remove the human-readable identifier for a specific bot-integration crossover. This is an experimental feature used for…
- Delete Knowledge Base Permanently deletes a knowledge base from Botpress by its knowledge base ID. Use this tool to remove knowledge bases that are no longer needed. The deletion is irreversible. Requires a valid knowledge base ID and the bo…
- Get Account Tool to get details of the authenticated account. Use after confirming valid credentials.
- Get Account Preference Tool to get a preference of the account. Use when you need to retrieve a specific account preference value by its key.
- Get All Workspace Quota Completion Tool to get a map of workspace IDs to their highest quota completion rate. Use when monitoring workspace usage or checking quota limits across multiple workspaces.
- Get Dereferenced Public Plugin By ID Tool to get a public plugin by ID with all interface entity references resolved to the corresponding entities as extended by the backing integrations. Use when you need to retrieve a plugin with its interfaces fully der…
- Get Integration Tool to get a specific Botpress integration by name and version. Use this to retrieve detailed information about an integration including its configuration, actions, events, channels, and metadata. Supports retrieving s…
- Get Public Integration Tool to retrieve a public integration by name and version from the Botpress hub. Use when you need to get integration details, check available actions/events/channels, or verify integration configuration.
- Get Public Integration By ID Tool to retrieve detailed information about a public Botpress integration by its ID. Use when you need to fetch integration details including configuration, channels, actions, events, and metadata.
- Get Public Interface Tool to get a public interface by name and version from the Botpress Hub. Use when you need to retrieve interface specifications, schemas, or metadata for integrations.
- Get Public Interface by ID Tool to retrieve a public interface by its ID from the Botpress Hub. Use when you need to get detailed information about a specific interface including its actions, events, channels, and entities.
- Get Public Plugin Tool to retrieve detailed information about a public plugin from Botpress Hub by name and version. Use when you need to inspect plugin configuration, dependencies, actions, events, or metadata before installation.
- Get Public Plugin By ID Tool to retrieve details of a public plugin by its unique ID. Use this to get full plugin information including configuration, actions, events, and metadata.
- Get Public Plugin Code Tool to retrieve public plugin code from Botpress Hub. Use when you need to access the source code for a specific plugin version on a particular platform (node or browser).
- Get Table Row Tool to fetch a specific row from a table using the row's unique identifier. Use when you need to retrieve detailed data for a specific table row.
- Get Upcoming Invoice Tool to get the upcoming invoice for a workspace. Use this to preview upcoming charges before they are billed.
- Get Workspace Tool to get detailed information about a specific Botpress workspace by ID. Use this when you need to retrieve workspace details such as plan, bot count, owner, billing info, or settings for a known workspace ID.
- Get Workspace Quota Tool to get workspace quota information for a specific usage type. Use when you need to check resource limits or usage for a workspace.
- List action runs Tool to list action runs for a specific integration of a bot. Use when you need to retrieve execution history of actions for a bot's integration, optionally filtering by timestamp range and paginating through results.
- List bot issues Tool to list issues associated with a specific bot. Use when you need to discover errors or configuration problems tied to a bot, optionally paginating through results.
- List conversations Tool to list all Conversations. Use when you need to retrieve and page through chat threads.
- List file tags Tool to list all tags used across all bot files. Use when you need to retrieve or display file tag metadata; supports pagination via nextToken.
- List file tag values Tool to list all values for a given file tag across all files. Use after determining the tag name; supports pagination via nextToken.
- List hub integrations Tool to list public integrations from the Botpress hub. Use when you need to browse available integrations, search for specific integration types, or filter integrations by various criteria such as verification status,…
- List integration api keys Tool to list Integration API Keys (IAKs) for a specific integration. Use when you need to retrieve all API keys associated with an integration within a workspace.
- List Integrations Tool to list integrations with filtering and sorting capabilities. Use when you need to browse available integrations, search for specific integration types, or filter integrations by various criteria such as verificati…
- List knowledge bases Tool to list knowledge bases for a bot. Use when you need to retrieve or display knowledge bases with optional tag filtering; supports pagination via nextToken.
- List Plugins Tool to list Botpress plugins. Use to discover available plugins, filter by name or version, or page through all plugins in a workspace.
- List Public Interfaces Tool to retrieve a list of public interfaces available in the Botpress Hub. Use when browsing available interfaces to integrate with bots.
- List public plugins Tool to retrieve a list of public plugins available in the Botpress hub. Use when browsing available plugins or searching for specific plugins by name and version.
- List public workspaces Tool to retrieve a list of public workspaces. Use when browsing publicly available workspaces before selection.
- List usage history Tool to retrieve usage history for a bot or workspace. Use to track resource consumption, monitor quota usage, or analyze historical trends for metrics like AI spend, member count, or invocation calls.
- List Workspace Invoices Tool to list all invoices billed to a workspace. Use when you need to retrieve billing history and invoice details for a specific workspace.
- List workspaces List all Botpress workspaces accessible to the authenticated user. Use this to enumerate workspaces, check workspace details like bot count and plan type, or find a specific workspace by handle. Supports pagination for…
- Request Integration Verification Tool to request verification for a Botpress integration via the Admin API. Use when you need to submit an integration for verification to make it available for public use.
- Botpress run vrl Tool to execute a VRL (Vector Remap Language) script against input data using the Botpress Admin API. Use when you need to transform or process data using VRL syntax. The script receives the input data and can perform t…
- Botpress send message Tool to send a message to an existing Botpress conversation via the Runtime API. Use when you need to create and deliver a message to a user.
- Set Account Preference Tool to set a preference for the account. Use when you need to create or update a specific account preference by its key.
- Set Workspace Preference Tool to set a preference for a Botpress workspace. Use when you need to store or update a workspace-specific preference value by its key.
- Update Account Tool to update details of the authenticated account. Use when you need to change the display name, profile picture, or refresh account data.
- Botpress update admin bots Tool to update an existing bot in a Botpress workspace via the Admin API. Use when you need to modify bot configuration, update tags, change code, or adjust any other bot properties. Only the fields you provide will be…
- Update admin workspace Tool to update a Botpress workspace via the Admin API. Use this to modify workspace properties including name, description, contact information, public visibility, handle, profile picture, social accounts, and spending…
- Botpress update workflow Tool to update a workflow object in Botpress by setting parameter values. Use when you need to change workflow status, add output data, update tags, or set failure reasons. Any parameters not provided will remain unchan…
- Botpress validate integration update Tool to validate an integration update request in Botpress Admin API. Use when you need to verify that integration update parameters are valid before performing the actual update. Returns success if the integration can…
Setup
How we connect it
- 1
Connect your account
You create a key in Botpress, a key you create and control, and paste it in once. It lives in a secrets store on your server, not with us.
- 2
Set the guardrails
Read-only by default. You choose which write actions the agent may take, and anything outside that policy gets confirmed with you first.
- 3
We keep it running
Health checks on every connection, updates handled for you, and we watch the first week of activity to make sure the work lands.
FAQ
Botpress questions, answered.
With a key you create and control. You paste it in once, it is stored in a secrets store on your server, permissions are scoped to the minimum the agent needs, and you can revoke it at any time.
The actions Botpress's API allows, the same things a person clicking around the app could do. Connections start read-only by default; write actions are confirmed against the policy you set before the agent takes them.
Connections are priced per tool on top of the base plan. Some are included, some are premium. See pricing for how connection charges work.
Standard tools are ready inside 7 business days of the setup call. We test the connection end to end, walk you through how the agent uses it, and watch the first week of activity.
Ready to put Botpress to work?
Tell us what your team runs on. We set up the connection, secure it, and your agent takes it from there.
All product names, logos, and brands are property of their respective owners; used for identification only. ZeroToClaw is not affiliated with or endorsed by Botpress.