Skip to main content
Botpress logo
  • Category: ai chatbots
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 53
  • Triggers: 0
  • Slug: BOTPRESS
  • Version: 20261101_00

Tools

Slug: 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

string
required
Workspace ID to get usage data for. Must be a valid workspace identifier.
string ("invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive")
required
Usage type to break down by bot. Determines what metric to report for each bot.
string
Period to get usage data for. If not specified, returns current usage data.
string
Set to ‘true’ to receive integration instances keyed by their alias instead of their id. This supports bots with multiple instances of the same integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTPRESS_CHARGE_WORKSPACE_UNPAID_INVOICESCharge specified unpaid invoices for a Botpress workspace. Returns details of invoices successfully charged and those that failed.

Input Parameters

string
required
Workspace ID for which to charge unpaid invoices.
array
required
Array of invoice IDs to charge. Must contain at least one invoice ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Workspace handle to check for availability. Must be 1-50 characters, lowercase alphanumeric with hyphens and underscores only (pattern: ^[a-z0-9-_]+$)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Indicates if the integration is a development integration. Dev integrations run locally.
string
URL of the integration for development integrations.
string
JavaScript code of the integration containing the integration logic.
string
Base64 encoded SVG of the integration icon. This icon is global to the integration; each version will be updated when this changes.
string
required
Name of the integration (max 200 characters). Typically in the format ‘namespace/integration-name’.
object
User object configuration with creation settings and tags.
string
Title of the integration displayed in the UI (1-64 characters).
object
Event definitions with schema for custom integration events.
array
List of layer names for the integration.
boolean
[DEPRECATED] Indicates whether the integration is public. Please use the ‘visibility’ parameter instead.
string
Base64 encoded markdown of the integration readme. The readme is specific to each integration version.
object
State definitions with type and schema.
object
Action definitions for the integration. Each action must have input and output schemas.
object
Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing. Values limited to 20000 characters.
string
required
Version of the integration (max 200 characters). Use semantic versioning format.
object
Channel definitions with messages schema.
object
Entity definitions with schema.
object
Optional attributes for the integration. Each value limited to 200 characters.
object
Global identifier configuration with extractScript and fallbackHandlerScript (max 2000 characters each).
object
Interface definitions with id, actions, channels, entities, and events.
string ("public" | "private" | "unlisted")
Integration visibility options.
string
Description of the integration displayed in the UI (max 256 characters).
object
Default configuration definition of the integration with description, identifier, schema, and title properties.
object
Additional configuration definitions of the integration.
string
required
Workspace ID where the integration will be created. This is passed as a header.
object
EXPERIMENTAL Extra integration operations that should be sent or not to the integration instances. The key is the operation name.
string
Whether the client supports bots with multiple instances of the same integration. Set to “true” to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the workspace to create. This will be the display name for the workspace.
string
Whether the client supports bots with multiple instances of the same integration. Set to ‘true’ to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Indicates if this is a development bot. Set to true for local development bots.
string
URL for development bot webhooks. Only applicable when dev=true.
string
JavaScript code containing the bot’s custom logic and behavior.
string
Name identifier for the bot. If not provided, the API will auto-generate a unique name. Must be unique within the workspace.
object
Custom key-value metadata tags for the bot. Each value limited to 500 characters.
object
User tag definitions for metadata on user objects.
object
Event definitions with title, description, and schema for custom bot events.
array
Array of media files. Each item must have ‘url’ and ‘name’ properties.
object
Conversation/user/bot/task state definitions with schema validation and expiry settings.
object
Custom action definitions with input/output schemas for bot actions.
object
Message tag definitions for metadata on message objects.
object
Conversation tag definitions for metadata on conversation objects.
object
Bot configuration object with ‘data’ and ‘schema’ properties for validation rules.
object
Event subscription configuration. Set to null to subscribe to all events.
object
Scheduled events configuration using cron expressions with type and payload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional custom identifier for the conversation. If not provided, one will be auto-generated.
object
required
Tags for the conversation. Required tags depend on the specific integration. Provide as a dictionary of key-value pairs.
string
required
UUID of the bot to create the conversation for. This is passed as the x-bot-id header.
string
required
Channel name as defined in the integration. For chat integration, use ‘channel’. This must match a channel defined in the specific integration being used.
string
Integration identifier (UUID). Either integration_id or integration_alias must be provided. This is passed as the x-integration-id header.
string
Integration alias. Either integration_id or integration_alias must be provided. This is passed as the x-integration-alias header.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the workspace to be deleted. Workspace IDs start with ‘wkspace_’ prefix (e.g., ‘wkspace_01KH9PBRKXEGBACYGWP7BBETR4’). Can be obtained from list workspaces API.
string
Whether the client supports bots with multiple instances of the same integration. Set to ‘true’ to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the file to be deleted. File IDs start with ‘file_’ prefix (e.g., ‘file_01K0B5160BQXX0XB66EFQJZ7YD’). Can be obtained from list files API or file creation response.
string
required
The UUID of the bot that owns the file. Required for authentication. Can be obtained from the list bots or workspace APIs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTPRESS_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 experimental feature used for the integrations channel sandbox.

Input Parameters

string
required
UUID of the bot that has the integration installed. Can be obtained from list bots or workspace APIs.
string
Integration Version ID identifying the installed integration. Starts with ‘intver_’ prefix (e.g., ‘intver_01KBFTKJ7841MVQTYFRT623SP5’). Required unless integrationInstanceAlias is provided.
string
required
Workspace ID where the bot is located. Required for authentication. Can be obtained from list workspaces API.
string
Whether the client supports bots with multiple instances of the same integration. Set to ‘true’ to receive integration instances keyed by their alias instead of their id. This header will be removed in the future.
string
Integration instance alias. If provided, integrationId is ignored and the operation targets the integration instance with this alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the knowledge base to be deleted. Knowledge base IDs start with ‘kb_’ prefix (e.g., ‘kb_01KH9PMBVK4YQHFT394BD4DG8X’). Can be obtained from list knowledge bases API or knowledge base creation response.
string
required
The UUID of the bot that owns the knowledge base. Required for authentication. Can be obtained from the list bots or workspace APIs.
string
User Id. Optional header parameter for user-scoped operations.
string
User Role. Optional header parameter for role-based access control.
string
Integration id. Optional header parameter for integration-scoped operations.
string
Integration name. Optional header parameter for identifying the integration.
string
Integration alias. Optional header parameter as an alternative to integration_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTPRESS_GET_ACCOUNTTool to get details of the authenticated account. Use after confirming valid credentials.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Preference key to retrieve. Must be a valid preference key that exists in the account.
string
Whether the client supports bots with multiple instances of the same integration. Set to ‘true’ to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Whether the client supports bots with multiple instances of the same integration. Set to “true” to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Plugin ID. Plugin IDs start with ‘plugver_’ prefix (e.g., ‘plugver_01KC4E6R93D99R34HBP2BADG5Z’).
object
required
Interfaces and their backing integrations. A JSON object mapping interface aliases to integration IDs. The plugin will be returned with all entity references resolved to the corresponding entities as extended by the backing integrations. Example: {‘hitl’: ‘intver_01KGJFKEQH2GVMK6XHJ9194J75’}
string
Whether the client supports bots with multiple instances of the same integration. Set to “true” to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Integration name. Format: ‘namespace/integration-name’ (e.g., ‘composio-test/my-integration’). The namespace is typically the workspace or user handle.
string
required
Integration version. Can be a semver version (e.g., ‘1.0.0’), a semver version range (e.g., ‘^1.0.0’), or the string ‘latest’ to get the most recent version.
string
required
Workspace ID to use for the request. Required for authentication. Format: ‘wkspace_’ followed by alphanumeric characters.
string
Whether the client supports bots with multiple instances of the same integration. Set to ‘true’ to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Integration name. This is the unique identifier for the integration in the Botpress hub.
string
required
Integration version. Can be a specific semver version (e.g., “1.2.3”), a semver version range (e.g., “^1.0.0”), or the constant string “latest” to get the most recent version.
string
Whether the client supports bots with multiple instances of the same integration. Set to “true” to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Integration Version ID to retrieve. Must be between 28-36 characters.
string
Whether the client supports bots with multiple instances of the same integration. Set to “true” to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Interface name to retrieve
string
required
Interface version. Either a semver version, semver version range, or the constant string ‘latest’
string
Whether the client supports bots with multiple instances of the same integration. Set to ‘true’ to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Interface ID to retrieve
string
Whether the client supports bots with multiple instances of the same integration. Set to “true” to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Plugin Name to retrieve from Botpress Hub.
string
required
Plugin version. Either a semver version (e.g., “1.3.0”), semver version range (e.g., “^1.0.0”), or the constant string “latest” to get the most recent version.
string
Whether the client supports bots with multiple instances of the same integration. Set to ‘true’ to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Plugin ID. Plugin IDs start with ‘plugver_’ prefix (e.g., ‘plugver_01KCA036HEMXKNMPKZZ6H9HVN9’). Can be obtained from the list public plugins API.
string
Whether the client supports bots with multiple instances of the same integration. Set to “true” to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Plugin id. This is the unique identifier for the plugin version.
string ("node" | "browser")
required
Platform for which to retrieve the plugin code. Must be either ‘node’ or ‘browser’.
string
Whether the client supports bots with multiple instances of the same integration. Set to ‘true’ to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTPRESS_GET_TABLE_ROWFetch a specific Botpress table row by table and row ID. The structured response contains the row ID, computed values, and supported row metadata; arbitrary row fields are not retained.

Input Parameters

integer
required
Identifier of the row within the table.
string
required
Bot id. This is passed as the x-bot-id header.
string
required
The table’s name or unique identifier for targeting specific table operations.
string
User Id. This is passed as the x-user-id header.
string
User Role. This is passed as the x-user-role header.
string
Integration id. This is passed as the x-integration-id header.
string
Integration name. This is passed as the x-integration-name header.
string
Integration alias. This is passed as the x-integration-alias header.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTPRESS_GET_UPCOMING_INVOICETool to get the upcoming invoice for a workspace. Use this to preview upcoming charges before they are billed.

Input Parameters

string
required
Workspace ID to retrieve the upcoming invoice for. Use ListWorkspaces to find available workspace IDs.
string
Whether the client supports bots with multiple instances of the same integration. Set to “true” to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Workspace ID to retrieve. This is the unique identifier for the workspace.
string
Whether the client supports bots with multiple instances of the same integration. Set to ‘true’ to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Workspace ID to get quota information for
string ("invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive")
required
Usage type to get quota for
string
Period to get quota for (e.g., ‘monthly’, ‘daily’). If not provided, returns the default period.
string
Whether the client supports bots with multiple instances of the same integration. Set to ‘true’ to receive integration instances keyed by their alias instead of their id. This header will be removed in the future.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier (UUID) of the bot to list action runs for. Obtain this from a list bots operation.
string
Pagination token from previous response. Provide the meta.nextToken value from the last API response to retrieve the next page of results.
string
Start timestamp (inclusive) to filter action runs. Format: ISO 8601 timestamp.
string
End timestamp (inclusive) to filter action runs. Format: ISO 8601 timestamp.
string
required
Workspace ID header. Required for authentication and authorization.
string
required
Name of the integration to filter action runs by. Required parameter.
string
Whether the client supports bots with multiple instances of the same integration. Set to ‘true’ to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier (UUID) of the bot to list issues for. Obtain this from a list bots operation.
string
Pagination token from previous response to retrieve the next page of results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTPRESS_LIST_CONVERSATIONSTool to list all Conversations. Use when you need to retrieve and page through chat threads.

Input Parameters

object
Filter conversations by tags. Provide a dictionary of tag key-value pairs where both keys and values are strings.
string
required
UUID of the bot to list conversations for. This is passed as the x-bot-id header.
string
Filter by channel name.
string
Pagination token from previous response to retrieve the next page of results.
string ("createdAt" | "updatedAt")
Field to sort conversations by.
string ("asc" | "desc")
Sort order direction: asc or desc.
array
Filter conversations by participant IDs. Returns conversations that include these participants.
string
Filter by integration name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTPRESS_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.

Input Parameters

string
required
The unique UUID identifier of the bot whose file tags should be listed. Must be a valid UUID format (e.g., ‘6caea721-d6e9-42f8-b764-f7d36c76c69e’). Sent as x-bot-id header.
string
Pagination token from a previous response’s meta.nextToken field to retrieve the next page of tags. Leave empty for the first request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The tag name to retrieve values for. Use LIST_FILE_TAGS to discover available tags first.
string
required
UUID of the bot whose file tag values should be listed. This is passed as the x-bot-id header.
string
Pagination token from a previous response’s meta.nextToken to retrieve the next page of values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Filter by integration name (exact match).
integer
Maximum number of results to return per page.
Search integrations by name, description, actions, and interfaces. Responses include a matchedOn field indicating which fields matched the search.
string ("popularity" | "name" | "createdAt" | "updatedAt" | "installCount")
Sort field options for integrations.
string
Integration version. Either a semver version (e.g., “1.0.0”) or the tag “latest”.
string ("asc" | "desc")
Sort direction options.
string
Provide the meta.nextToken value from the last API response to retrieve the next page of results.
string
Filter integrations by implemented interface ID.
string
Filter integrations by implemented interface name (strict match).
string
Bot ID. Required when filtering for installed integrations.
string ("unapproved" | "pending" | "approved" | "rejected")
Verification status values for integrations.
string
Whether the client supports bots with multiple instances of the same integration. Set to “true” to receive integration instances keyed by their alias instead of their id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
ID of the integration to list API keys for. Must be a valid integration version identifier (e.g., ‘intver_01KH9P8S2B4FWPB9TWA50YJ95M’).
string
required
Workspace ID to operate within. This is sent as the x-workspace-id header.
string
Whether the client supports bots with multiple instances of the same integration. Set to ‘true’ to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
If true, only dev integrations are returned. Otherwise, only production integrations are returned.
string
Filter by integration name (exact match).
integer
Maximum number of results to return per page.
string
Search integrations by name, description, actions, and interfaces. Responses include a matchedOn field indicating which fields matched the search.
string ("popularity" | "name" | "createdAt" | "updatedAt" | "installCount")
Sort field options for integrations.
string
Integration version. Either a semver version (e.g., “1.0.0”) or the tag “latest”.
string ("asc" | "desc")
Sort direction options.
string
Provide the meta.nextToken value from the last API response to retrieve the next page of results.
string ("public" | "private")
Visibility options for integrations.
string
Filter integrations by implemented interface ID.
string
Filter integrations by implemented interface name (strict match).
string
required
Workspace ID. Required for authentication. Format: ‘wkspace_’ followed by alphanumeric characters.
string
Bot ID. Required when filtering for installed integrations.
string ("unapproved" | "pending" | "approved" | "rejected")
Verification status values for integrations.
string
Whether the client supports bots with multiple instances of the same integration. Set to “true” to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Filter knowledge bases by tags. Tags should be passed as a URL-encoded JSON object of key-value pairs that must be present in the tags of a knowledge base. An array of multiple string values for the same key are treated as an OR condition. To exclude a value, express it as an object with a nested ‘not’ key with the string or string-array value(s) to exclude.
string
required
The unique UUID identifier of the bot whose knowledge bases should be listed. Must be a valid UUID format. Sent as x-bot-id header.
string
User Id. Sent as x-user-id header.
string
User Role. Sent as x-user-role header.
string
Provide the meta.nextToken value provided in the last API response to retrieve the next page of results. Leave empty for the first request.
string
Integration id. Sent as x-integration-id header.
string
Integration name. Sent as x-integration-name header.
string
Integration alias. Sent as x-integration-alias header.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Filter all versions of a plugin by name.
string
Filter a plugin by name and version. Must be used together with the name parameter.
string
Provide the meta.nextToken value provided in the last API response to retrieve the next page of results.
string
required
Workspace ID. This is passed as the x-workspace-id header.
string
Whether the client supports bots with multiple instances of the same integration. Set to “true” to receive integration instances keyed by their alias instead of their id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Filter all versions of an interface by name.
string
Filter an interface by name and version.
string
Provide the meta.nextToken value provided in the last API response to retrieve the next page of results.
string
Whether the client supports bots with multiple instances of the same integration. Set to “true” to receive integration instances keyed by their alias instead of their id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Filter all versions of a plugin by name.
string
Filter a plugin by name and version. Requires the name parameter to be set as well.
string
Provide the meta.nextToken value from the last API response to retrieve the next page of results.
string
Whether the client supports bots with multiple instances of the same integration. Set to ‘true’ to receive integration instances keyed by their alias instead of their id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTPRESS_LIST_PUBLIC_WORKSPACESTool to retrieve a list of public workspaces. Use when browsing publicly available workspaces before selection.

Input Parameters

string
Filter workspaces by search string.
string
Pagination token from previous response meta.nextToken.
array
Filter by list of workspace IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
ID of a bot or a workspace, depending on the ‘type’ parameter. Use workspace ID for workspace-level metrics or bot ID for bot-specific metrics.
string ("invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive")
required
Type of usage metric to retrieve history for. Determines what kind of usage data is returned.
string
required
Workspace ID for authentication and authorization context. Required for all admin API calls.
string
Whether the client supports bots with multiple instances of the same integration. Set to ‘true’ to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Workspace ID to list invoices for. This is a unique identifier for the workspace.
string
Whether the client supports bots with multiple instances of the same integration. Set to ‘true’ to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Filter workspaces by exact handle. If not provided, returns all workspaces for the authenticated user. Must not be empty if provided.
string
Token for pagination. Use the value from meta.nextToken in a previous response to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier of the integration to request verification for. Must be a valid integration ID.
string
required
Workspace ID where the integration belongs. This is passed as a header.
string
Whether the client supports bots with multiple instances of the same integration. Set to ‘true’ to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Input data object to be processed by the VRL script. This data is accessible within the script as ’.’ (dot notation).
string
required
VRL (Vector Remap Language) script to execute. The script processes the input data and transforms it according to VRL syntax.
string
required
Workspace ID. Required for VRL script execution.
string
Whether the client supports bots with multiple instances of the same integration. Set to “true” to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
Key-value pairs for message categorization. Keys are limited to 500 characters.
string
required
Message resource type (max 200 characters). Typically ‘text’ for text messages.
string
required
UUID of the bot to send the message for. This is passed as the x-bot-id header.
string
Message origin. Only ‘synthetic’ is supported as a value.
string
required
Unique identifier of the user sending or receiving the message (28-36 characters). Must be obtained from getOrCreateUser endpoint.
object
required
Message content object. For text messages, use {‘text’: ‘your message’}. Supports Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location.
object
Configuration for scheduling message delivery.
string
required
Unique identifier of the conversation (28-36 characters). Must be obtained from getOrCreateConversation or list conversations endpoints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Preference key to set. The key identifies the preference to create or update in the account.
string
required
The value to set for the preference. Can be a string, number, boolean, null, object with string/number/boolean values, or array of primitives.
string
Whether the client supports bots with multiple instances of the same integration. Set to ‘true’ to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Preference key to set. This identifies the preference to be stored in the workspace.
string
required
The value to set for the preference. Can be of any type (string, number, boolean, object, array, or null).
string
required
The workspace ID for which to set the preference. Can be obtained by calling GET /v1/admin/workspaces endpoint.
string
Whether the client supports bots with multiple instances of the same integration. Set to ‘true’ to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTPRESS_UPDATE_ACCOUNTTool to update details of the authenticated account. Use when you need to change the display name, profile picture, or refresh account data.

Input Parameters

boolean
Whether to refresh the account data
string
Display name of the account (max 100 characters)
string
URL to the profile picture

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier of the bot to update. Must be a valid bot ID from your workspace.
boolean
Update whether this is a development bot. Development bots run locally and can install dev integrations.
string
Updated URL for development bot webhooks. Only applicable when dev=true.
string
Updated JavaScript code containing the bot’s custom logic and behavior.
string
Updated name for the bot. Must be at least 1 character if provided.
object
Updated custom key-value metadata tags for the bot. Each value limited to 500 characters. Replaces existing tags.
object
Updated user tag definitions for metadata on user objects.
object
Updated event definitions with title, description, and schema for custom bot events.
array
Updated list of layer identifiers for the bot.
array
Updated array of media files. Each item must have ‘url’ and ‘name’ properties.
object
Updated conversation/user/bot/task state definitions with schema validation and expiry settings.
object
Updated custom action definitions with input/output schemas for bot actions.
boolean
Update whether the bot is blocked from operating.
object
Updated message tag definitions for metadata on message objects.
object
Updated plugin configurations. A mapping of plugin aliases to their configuration.
boolean
Update whether the bot should be in always alive mode (stays active continuously).
object
Updated conversation tag definitions for metadata on conversation objects.
object
Updated integration configurations keyed by integration ID or alias.
object
Updated bot configuration object with ‘data’ and ‘schema’ properties for validation rules.
object
Updated event subscription configuration. Set to null to subscribe to all events.
string
Type of bot authentication. Currently only ‘iam’ is supported.
string
Workspace ID where the bot belongs. If not provided, the first accessible workspace will be used automatically.
object
Updated scheduled events configuration using cron expressions with type and payload.
integer
Updated maximum execution time in seconds for bot operations.
boolean
UNUSED field - will be removed in future. Please ignore.
string
Set to ‘true’ to receive integration instances keyed by alias instead of ID. This header will be removed in the future.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Workspace ID to update. Must be a valid workspace identifier accessible to the authenticated user.
string
Workspace name. Must be between 1 and 64 characters.
string
Description of the workspace. Provides context about the workspace’s purpose or team.
string
Workspace handle (URL-friendly identifier). Must be 1-64 characters, start and end with alphanumeric, contain only lowercase letters, numbers, hyphens, and underscores.
string
Website URL associated with the workspace.
boolean
Whether the workspace should be publicly visible. Set to true to make it discoverable.
string
Contact email address for the workspace.
number
Monthly spending limit in dollars. Must be between 5 and 1000.
string
URL to the workspace’s profile picture or logo.
array
List of social media account URLs (maximum 5 items).
string
Set to ‘true’ to receive integration instances keyed by alias instead of ID. This header supports bots with multiple instances of the same integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier of the workflow to update (28-36 characters).
object
Key-value pairs for workflow categorization. Individual keys can be unset by providing empty values. Each value is limited to 500 characters.
string
required
UUID of the bot that owns the workflow. This is passed as the x-bot-id header.
object
Data returned by the workflow output. Can contain arbitrary JSON structure.
string ("completed" | "cancelled" | "listening" | "paused" | "failed" | "in_progress")
Valid workflow status values.
string
Specific user ID related to this workflow (28-36 characters).
string
Event ID must be specified if the workflow is updated with status ‘in_progress’.
string
The timeout date when the workflow should fail, in ISO 8601 format.
string
Reason why the workflow failed. Use when status is set to ‘failed’.
string
Optional integration ID. This is passed as the x-integration-id header.
string
Optional integration alias. This is passed as the x-integration-alias header.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Input Parameters

string
required
Integration Version ID to validate update for (e.g., intver_01KH9P8S2B4FWPB9TWA50YJ95M)
string
URL of the integration
string
JavaScript code of the integration
string
Base64 encoded SVG of the integration icon. This icon is global to the integration and will update all versions.
object
User configuration for an integration.
string
Title of the integration displayed in the UI (max 64 characters, min 1 character)
object
Event definitions with schemas. Set to null to remove specific events.
array
Array of layer IDs for the integration
boolean
[DEPRECATED] Use visibility parameter instead. Indicates whether the integration is public.
string
Base64 encoded markdown of the integration readme. The readme is specific to this integration version.
object
State definitions with type and schema. Set to null to remove specific states.
object
Action definitions with input/output schemas. Set to null to remove specific actions.
object
Integration-wide secrets available as environment variables with SECRET_ prefix. Secret names must use SCREAMING_SNAKE casing (max 20000 characters per secret). Set to null to remove specific secrets.
object
Channel definitions with message schemas. Set to null to remove specific channels.
object
Entity definitions with schemas. Set to null to remove specific entities.
object
Optional attributes with max 200 characters per value. Set to null to remove specific attributes.
object
Identifier configuration for an integration.
object
Interface definitions with ID and optional actions/channels/entities/events. Set to null to remove specific interfaces.
string ("public" | "private" | "unlisted")
Enum for integration visibility options.
string
Description of the integration displayed in the UI (max 256 characters)
object
Configuration definition for an integration.
object
Additional configuration definitions of the integration. Set to null to remove specific configurations.
string
required
Workspace ID where the integration is located (e.g., wkspace_01K0B50V5WQHDN1J3YBJJF5TZ8)
object
[EXPERIMENTAL] Extra integration operations configuration. The key is the operation name.
integer
Maximum execution time of the integration in seconds
string
Whether the client supports multiple instances of the same integration. Set to “true” to receive integration instances keyed by alias instead of id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not