View all systems
Botpressai chatbots

53 available actions

What your AI agent can do in Botpress

Botpress is an open-source platform for building, deploying, and managing chatbots. This page lists every available action. Your agent only receives the actions and permissions required for the role you approve.

Common starting points

  • Get Upcoming InvoiceTool to get the upcoming invoice for a workspace.
  • Check Handle AvailabilityTool to check if a workspace handle is available in Botpress.
  • Update AccountTool to update details of the authenticated account.
  • Set Account PreferenceTool to set a preference for the account.
  • Delete Knowledge BasePermanently deletes a knowledge base from Botpress by its knowledge base ID.
  • Delete FilePermanently deletes a file from a Botpress bot's storage by its file ID.

Browse all 53 actions by capability

Open a capability to see every supported action and its description.

Find & reviewLook up and review existing recordsView 21 actionsHide actions
  • Check Handle AvailabilityTool to check if a workspace handle is available in Botpress.
  • Get AccountTool to get details of the authenticated account.
  • Get Account PreferenceTool to get a preference of the account.
  • Get All Workspace Quota CompletionTool to get a map of workspace IDs to their highest quota completion rate.
  • 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.
  • Get IntegrationTool to get a specific Botpress integration by name and version.
  • Get Public IntegrationTool to retrieve a public integration by name and version from the Botpress hub.
  • Get Public Integration By IDTool to retrieve detailed information about a public Botpress integration by its ID.
  • Get Public InterfaceTool to get a public interface by name and version from the Botpress Hub.
  • Get Public Interface by IDTool to retrieve a public interface by its ID from the Botpress Hub.
  • Get Public PluginTool to retrieve detailed information about a public plugin from Botpress Hub by name and version.
  • Get Public Plugin By IDTool to retrieve details of a public plugin by its unique ID.
  • Get Public Plugin CodeTool to retrieve public plugin code from Botpress Hub.
  • Get Table RowTool to fetch a specific row from a table using the row's unique identifier.
  • Get Upcoming InvoiceTool to get the upcoming invoice for a workspace.
  • Get WorkspaceTool to get detailed information about a specific Botpress workspace by ID.
  • Get Workspace QuotaTool to get workspace quota information for a specific usage type.
  • List IntegrationsTool to list integrations with filtering and sorting capabilities.
  • List PluginsTool to list Botpress plugins.
  • List Public InterfacesTool to retrieve a list of public interfaces available in the Botpress Hub.
  • List Workspace InvoicesTool to list all invoices billed to a workspace.
Update & manageChange and manage existing recordsView 3 actionsHide actions
  • Set Account PreferenceTool to set a preference for the account.
  • Set Workspace PreferenceTool to set a preference for a Botpress workspace.
  • Update AccountTool to update details of the authenticated account.
Remove & cancelRemove records or cancel supported workView 4 actionsHide actions
  • Delete Admin WorkspaceTool to permanently delete a workspace from Botpress admin.
  • Delete FilePermanently deletes a file from a Botpress bot's storage by its file ID.
  • Delete Integration Shareable IDTool to delete a shareable ID for an integration installed in a Botpress bot.
  • Delete Knowledge BasePermanently deletes a knowledge base from Botpress by its knowledge base ID.
Other actionsSpecialist and administrative actions.View 25 actionsHide actions
  • Break Down Workspace Usage By BotTool to break down workspace usage by bot.
  • BOTPRESS_CHARGE_WORKSPACE_UNPAID_INVOICESTool to charge unpaid invoices for a specific Botpress workspace.
  • BOTPRESS_CREATE_ADMIN_INTEGRATIONTool to create a new integration in a Botpress workspace via the Admin API.
  • BOTPRESS_CREATE_ADMIN_WORKSPACETool to create a new workspace in Botpress via the Admin API.
  • BOTPRESS_CREATE_BOTTool to create a new bot in a Botpress workspace via the Admin API.
  • BOTPRESS_CREATE_CONVERSATIONTool to create a new conversation in Botpress via the Runtime API.
  • LIST_ACTION_RUNSTool to list action runs for a specific integration of a bot.
  • LIST_BOT_ISSUESTool to list issues associated with a specific bot.
  • LIST_CONVERSATIONSTool to list all Conversations.
  • LIST_FILE_TAGSTool to list all tags used across all bot files.
  • LIST_FILE_TAG_VALUESTool to list all values for a given file tag across all files.
  • LIST_HUB_INTEGRATIONSTool to list public integrations from the Botpress hub.
  • LIST_INTEGRATION_API_KEYSTool to list Integration API Keys (IAKs) for a specific integration.
  • LIST_KNOWLEDGE_BASESTool to list knowledge bases for a bot.
  • LIST_PUBLIC_PLUGINSTool to retrieve a list of public plugins available in the Botpress hub.
  • LIST_PUBLIC_WORKSPACESTool to retrieve a list of public workspaces.
  • LIST_USAGE_HISTORYTool to retrieve usage history for a bot or workspace.
  • LIST_WORKSPACESList all Botpress workspaces accessible to the authenticated user.
  • Request Integration VerificationTool to request verification for a Botpress integration via the Admin API.
  • BOTPRESS_RUN_VRLTool to execute a VRL (Vector Remap Language) script against input data using the Botpress Admin API.
  • BOTPRESS_SEND_MESSAGETool to send a message to an existing Botpress conversation via the Runtime API.
  • BOTPRESS_UPDATE_ADMIN_BOTSTool to update an existing bot in a Botpress workspace via the Admin API.
  • UPDATE_ADMIN_WORKSPACETool to update a Botpress workspace via the Admin API.
  • BOTPRESS_UPDATE_WORKFLOWTool to update a workflow object in Botpress by setting parameter values.
  • BOTPRESS_VALIDATE_INTEGRATION_UPDATETool to validate an integration update request in Botpress Admin API.

Connection record

A connection you can control.

Sign-in
Customer-managed key
Setup
Use a key you create and control. It is stored securely and limited to the work agreed for the role.
Boundaries
Only the approved role and actions.
Off switch
Revoke the connection from your account.

FAQ

Before you connect Botpress

How does the agent connect to Botpress?
With a key you create and control. It is stored securely, permissions are limited to what the agent needs, and you can revoke it at any time.
What can the agent actually do in Botpress?
The page above lists the 53 actions currently available through the Botpress connection. The role determines which of those actions the agent may use, and write access is only enabled when the workflow needs it.
Is Botpress included in my plan?
Connections are priced per tool on top of the base plan. Some are included and some are premium. See pricing for how connection charges work.
How long until Botpress is ready?
Timing depends on the sign-in method, permissions and workflow being connected. We confirm the scope and setup plan before enabling the connection.

Bring the workflow together

Ready to put Botpress to work?

Start with the responsibility you want off your plate. We’ll map the connection and the boundaries around it.

Book a setup call Browse all connections

All product names, logos, and brands are property of their respective owners and are used for identification only. ZeroToClaw is not affiliated with or endorsed by Botpress.