- Category: ai chatbots
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 53
- Triggers: 0
- Slug:
BOTPRESS - Version: 20261101_00
Tools
Break Down Workspace Usage By Bot
Break Down Workspace Usage By Bot
BOTPRESS_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.Input Parameters
Output
BOTPRESS_CHARGE_WORKSPACE_UNPAID_INVOICES
BOTPRESS_CHARGE_WORKSPACE_UNPAID_INVOICES
Check Handle Availability
Check Handle Availability
BOTPRESS_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 alternative handles if unavailable.Input Parameters
Output
BOTPRESS_CREATE_ADMIN_INTEGRATION
BOTPRESS_CREATE_ADMIN_INTEGRATION
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 channels.Input Parameters
Output
BOTPRESS_CREATE_ADMIN_WORKSPACE
BOTPRESS_CREATE_ADMIN_WORKSPACE
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 authenticated account’s ownership.Input Parameters
Output
BOTPRESS_CREATE_BOT
BOTPRESS_CREATE_BOT
BOTPRESS_CREATE_BOTCreate a bot via the Botpress Admin API with optional name, code, tags, events and states. If no workspace header is present, the tool selects the first workspace returned for the authenticated account.Input Parameters
Output
BOTPRESS_CREATE_CONVERSATION
BOTPRESS_CREATE_CONVERSATION
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 being used.Input Parameters
Output
Delete Admin Workspace
Delete Admin Workspace
BOTPRESS_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.Input Parameters
Output
Delete File
Delete File
BOTPRESS_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 that owns the file.Input Parameters
Output
Delete Knowledge Base
Delete Knowledge Base
BOTPRESS_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 base ID and the bot ID that owns the knowledge base.Input Parameters
Output
Get Account
Get Account
Get Account Preference
Get Account Preference
BOTPRESS_GET_ACCOUNT_PREFERENCETool to get a preference of the account. Use when you need to retrieve a specific account preference value by its key.Input Parameters
Output
Get All Workspace Quota Completion
Get All Workspace Quota Completion
BOTPRESS_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.Input Parameters
Output
Get Dereferenced Public Plugin By ID
Get Dereferenced Public Plugin By ID
BOTPRESS_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 interfaces fully dereferenced using specific backing integrations.Input Parameters
Output
Get Integration
Get Integration
BOTPRESS_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. Supports retrieving specific versions or the latest version.Input Parameters
Output
Get Public Integration
Get Public Integration
BOTPRESS_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 configuration.Input Parameters
Output
Get Public Integration By ID
Get Public Integration By ID
BOTPRESS_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.Input Parameters
Output
Get Public Interface
Get Public Interface
BOTPRESS_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.Input Parameters
Output
Get Public Interface by ID
Get Public Interface by ID
BOTPRESS_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.Input Parameters
Output
Get Public Plugin
Get Public Plugin
BOTPRESS_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 installation.Input Parameters
Output
Get Public Plugin By ID
Get Public Plugin By ID
BOTPRESS_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.Input Parameters
Output
Get Public Plugin Code
Get Public Plugin Code
BOTPRESS_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).Input Parameters
Output
Get Table Row
Get Table Row
Get Upcoming Invoice
Get Upcoming Invoice
BOTPRESS_GET_UPCOMING_INVOICETool to get the upcoming invoice for a workspace. Use this to preview upcoming charges before they are billed.Input Parameters
Output
Get Workspace
Get Workspace
BOTPRESS_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 workspace ID.Input Parameters
Output
Get Workspace Quota
Get Workspace Quota
BOTPRESS_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.Input Parameters
Output
LIST_ACTION_RUNS
LIST_ACTION_RUNS
BOTPRESS_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 through results.Input Parameters
Output
LIST_BOT_ISSUES
LIST_BOT_ISSUES
BOTPRESS_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.Input Parameters
Output
LIST_CONVERSATIONS
LIST_CONVERSATIONS
BOTPRESS_LIST_CONVERSATIONSTool to list all Conversations. Use when you need to retrieve and page through chat threads.Input Parameters
Output
LIST_FILE_TAG_VALUES
LIST_FILE_TAG_VALUES
BOTPRESS_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.Input Parameters
Output
LIST_HUB_INTEGRATIONS
LIST_HUB_INTEGRATIONS
BOTPRESS_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 verification status, interface, or installation status.Input Parameters
Output
LIST_INTEGRATION_API_KEYS
LIST_INTEGRATION_API_KEYS
BOTPRESS_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.Input Parameters
Output
List Integrations
List Integrations
BOTPRESS_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 such as verification status, interface, visibility, or installation status.Input Parameters
Output
LIST_KNOWLEDGE_BASES
LIST_KNOWLEDGE_BASES
BOTPRESS_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.Input Parameters
Output
List Plugins
List Plugins
BOTPRESS_LIST_PLUGINSTool to list Botpress plugins. Use to discover available plugins, filter by name or version, or page through all plugins in a workspace.Input Parameters
Output
List Public Interfaces
List Public Interfaces
BOTPRESS_LIST_PUBLIC_INTERFACESTool to retrieve a list of public interfaces available in the Botpress Hub. Use when browsing available interfaces to integrate with bots.Input Parameters
meta.nextToken value provided in the last API response to retrieve the next page of results.Output
LIST_PUBLIC_PLUGINS
LIST_PUBLIC_PLUGINS
BOTPRESS_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.Input Parameters
Output
LIST_PUBLIC_WORKSPACES
LIST_PUBLIC_WORKSPACES
LIST_USAGE_HISTORY
LIST_USAGE_HISTORY
BOTPRESS_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.Input Parameters
Output
List Workspace Invoices
List Workspace Invoices
BOTPRESS_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.Input Parameters
Output
LIST_WORKSPACES
LIST_WORKSPACES
BOTPRESS_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. Supports pagination for accounts with many workspaces.Input Parameters
Output
Request Integration Verification
Request Integration Verification
BOTPRESS_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.Input Parameters
Output
BOTPRESS_RUN_VRL
BOTPRESS_RUN_VRL
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 data and can perform transformations, validations, or data manipulations.Input Parameters
Output
BOTPRESS_SEND_MESSAGE
BOTPRESS_SEND_MESSAGE
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.Input Parameters
Output
Set Account Preference
Set Account Preference
BOTPRESS_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.Input Parameters
Output
Set Workspace Preference
Set Workspace Preference
BOTPRESS_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.Input Parameters
Output
Update Account
Update Account
BOTPRESS_UPDATE_ADMIN_BOTS
BOTPRESS_UPDATE_ADMIN_BOTS
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 you provide will be updated.Input Parameters
Output
UPDATE_ADMIN_WORKSPACE
UPDATE_ADMIN_WORKSPACE
BOTPRESS_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 accounts, and spending limits.Input Parameters
Output
BOTPRESS_UPDATE_WORKFLOW
BOTPRESS_UPDATE_WORKFLOW
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 will remain unchanged.Input Parameters
Output
BOTPRESS_VALIDATE_INTEGRATION_UPDATE
BOTPRESS_VALIDATE_INTEGRATION_UPDATE
BOTPRESS_VALIDATE_INTEGRATION_UPDATEValidate a proposed integration update through the Botpress Admin API. The tool reports success when the validation request returns a successful, JSON-parseable response.