Botpress for AI agents
Agents read Botpress at once. Changes and sends are held for a person's approval by default.
About Botpress
Botpress is an open-source platform for building, deploying, and managing chatbots.
What an agent can do in Botpress
Every Botpress action is classed by the platform as a read, a change or a send. Reads run at once. Changes and sends are held for a person by default.
Runs at once (reads)
Looks things up in Botpress without asking first. 35 actions.
- Get IntegrationTool 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. Su
- Get WorkspaceTool 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 w
- List IntegrationsTool 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
- Break Down Workspace Usage By BotTool 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.
- Check Handle AvailabilityTool 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 alter
- Get AccountTool to get details of the authenticated account. Use after confirming valid credentials.
- Get Account PreferenceTool 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 CompletionTool 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 IDTool 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 i
- Get Public IntegrationTool 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 configurat
- Get Public Integration By IDTool 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 InterfaceTool 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.
Show all 35
- Get Public Interface by IDTool 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 PluginTool 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
- Get Public Plugin By IDTool 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 CodeTool 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 RowTool 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 InvoiceTool to get the upcoming invoice for a workspace. Use this to preview upcoming charges before they are billed.
- Get Workspace QuotaTool 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_RUNSTool 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
- LIST_BOT_ISSUESTool 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_CONVERSATIONSTool to list all Conversations. Use when you need to retrieve and page through chat threads.
- LIST_FILE_TAGSTool 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_VALUESTool to list all values for a given file tag across all files. Use after determining the tag name; supports pagination via nextToken.
- LIST_HUB_INTEGRATIONSTool 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 ve
- LIST_INTEGRATION_API_KEYSTool 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_KNOWLEDGE_BASESTool 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 PluginsTool to list Botpress plugins. Use to discover available plugins, filter by name or version, or page through all plugins in a workspace.
- List Public InterfacesTool to retrieve a list of public interfaces available in the Botpress Hub. Use when browsing available interfaces to integrate with bots.
- LIST_PUBLIC_PLUGINSTool 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_WORKSPACESTool to retrieve a list of public workspaces. Use when browsing publicly available workspaces before selection.
- LIST_USAGE_HISTORYTool 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 InvoicesTool to list all invoices billed to a workspace. Use when you need to retrieve billing history and invoice details for a specific workspace.
- LIST_WORKSPACESList 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. Suppo
- BOTPRESS_VALIDATE_INTEGRATION_UPDATETool 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 t
Held for approval by default (changes and sends)
Held for a person's approval by default. The approval is recorded and the action is sent once, never twice, with 10 seconds to undo. 18 actions.
- BOTPRESS_CREATE_BOTTool 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_CONVERSATIONTool 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 bei
- BOTPRESS_SEND_MESSAGETool 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.
- BOTPRESS_UPDATE_ADMIN_BOTSTool 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 y
- BOTPRESS_UPDATE_WORKFLOWTool 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
- BOTPRESS_CHARGE_WORKSPACE_UNPAID_INVOICESTool 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
- BOTPRESS_CREATE_ADMIN_INTEGRATIONTool 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 chan
- BOTPRESS_CREATE_ADMIN_WORKSPACETool 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 au
- Delete Admin WorkspaceTool 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 FilePermanently 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
- Delete Integration Shareable IDTool 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 experimenta
- Delete Knowledge BasePermanently 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
Show all 18
- Request Integration VerificationTool 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_VRLTool 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 dat
- Set Account PreferenceTool to set a preference for the account. Use when you need to create or update a specific account preference by its key.
- Set Workspace PreferenceTool 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 AccountTool to update details of the authenticated account. Use when you need to change the display name, profile picture, or refresh account data.
- UPDATE_ADMIN_WORKSPACETool 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 acco
Changes wait in Needs you
Changes and sends in Botpress are held for a person's approval by default. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
Botpress questions
Can an agent change data in Botpress on its own?
Not by default. Changes and sends in Botpress are held for a person's approval. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
What can an agent read in Botpress?
This connector lists 35 read actions. Reads run at once, without waiting for approval.
How does Botpress connect?
It connects with API key. Connectors are built and maintained by third-party developers; availability is confirmed during scoping.