API_KEY
botpress_api_key
Developer setup
No fields declared in this snapshot.
User connection
- Personal Access Tokenbearer_token · stringRequired
BOTPRESS
Botpress is an open-source platform for building, deploying, and managing chatbots.
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
53
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
API_KEY
No fields declared in this snapshot.
Capability index
Showing 1–30 of 53 actions
BOTPRESS_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.
Untrusted display-only summary
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.
Untrusted display-only summary
BOTPRESS_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 unavailable.
Untrusted display-only summary
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.
Untrusted display-only summary
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's ownership.
Untrusted display-only summary
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.
Untrusted display-only summary
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.
Untrusted display-only summary
BOTPRESS_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.
Untrusted display-only summary
BOTPRESS_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.
Untrusted display-only summary
BOTPRESS_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 the integrations channel sandbox.
Untrusted display-only summary
BOTPRESS_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 bot ID that owns the knowledge base.
Untrusted display-only summary
BOTPRESS_GET_ACCOUNT
Tool to get details of the authenticated account. Use after confirming valid credentials.
Untrusted display-only summary
BOTPRESS_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.
Untrusted display-only summary
BOTPRESS_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.
Untrusted display-only summary
BOTPRESS_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 dereferenced using specific backing integrations.
Untrusted display-only summary
BOTPRESS_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 specific versions or the latest version.
Untrusted display-only summary
BOTPRESS_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.
Untrusted display-only summary
BOTPRESS_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.
Untrusted display-only summary
BOTPRESS_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.
Untrusted display-only summary
BOTPRESS_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.
Untrusted display-only summary
BOTPRESS_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.
Untrusted display-only summary
BOTPRESS_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.
Untrusted display-only summary
BOTPRESS_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).
Untrusted display-only summary
BOTPRESS_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.
Untrusted display-only summary
BOTPRESS_GET_UPCOMING_INVOICE
Tool to get the upcoming invoice for a workspace. Use this to preview upcoming charges before they are billed.
Untrusted display-only summary
BOTPRESS_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.
Untrusted display-only summary
BOTPRESS_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.
Untrusted display-only summary
BOTPRESS_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.
Untrusted display-only summary
BOTPRESS_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.
Untrusted display-only summary
BOTPRESS_LIST_CONVERSATIONS
Tool to list all Conversations. Use when you need to retrieve and page through chat threads.
Untrusted display-only summary
Provenance
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.