Botpress MCP connector

• Create Create a Botpress helper vrl Run a VRL (Vector Remap Language) script in Botpress. Returns the result of the script execution.
• Delete Delete a Botpress admin account by ID Delete the Botpress account associated with the authenticated user. Returns: id, name, createdAt, updatedAt.
• List List all Botpress admin accounts Retrieve the current authenticated account's profile, including email, display name, email verification status, and profile picture.
• Update Botpress admin accounts bulk update Update details of the Botpress account associated with the authenticated user. Returns: id, name, createdAt, updatedAt.
• List List all Botpress account pats List Personal Access Tokens (PATs) for the authenticated Botpress account. Returns: id, createdAt, updatedAt.
• Create Create a Botpress account pat Create a new Personal Access Token (PAT) in Botpress. Returns: id, createdAt, updatedAt.
• Delete Delete a Botpress account pat by ID Delete a Personal Access Token (PAT) by id. Required: id. Returns an empty 204 response on success.
• Get Get single Botpress account preference by ID Get a Botpress account preference by its preference key. Returns the preference object including its key and value. Required: id.
• Create Create a Botpress account preference Set a preference for a Botpress account by preference key. Returns the updated preference object including its key and value. Required: preference_id, value.
• List List all Botpress hub integrations List public Botpress hub integrations with filtering, search, and sorting capabilities. Returns each integration with id, name, version, description, createdAt, updatedAt, installCount, verificationStatus, actions, and interfaces. When the search parameter is used, responses also include a matchedOn field indicating which fields matched.
• Get Get single Botpress hub integration by ID Get a single public Botpress hub integration by its integration version ID. Returns: id, name, version, description, createdAt, updatedAt, installCount, verificationStatus, matchedOn, actions, interfaces. Required: id.
• Get Botpress hub integrations get by name Get a public Botpress hub integration by name and version. Returns: id, name, version, description, createdAt, updatedAt, installCount, verificationStatus, matchedOn, actions, interfaces. Required: name, version. The version accepts a semver version, semver range, or the constant string "latest".
• List List all Botpress hub plugins List public plugins from the Botpress Hub, optionally filtered by name and/or version. Returns: id, name, version, createdAt, updatedAt.
• Get Get single Botpress hub plugin by ID Get a single public plugin from the Botpress Hub by id. Returns: id, name, version, createdAt, updatedAt. Required: id.
• Get Botpress hub plugins get by name Get a public Botpress hub plugin by name and version. Returns: id, name, version, createdAt, updatedAt. Required: name, version. The version parameter accepts a semver version, a semver version range, or the constant string "latest".
• List List all Botpress plugin dereferenceds Get a public Botpress Hub plugin by ID with all interface entity references resolved to the corresponding entities as extended by the backing integrations. Returns: id, name, version, createdAt, updatedAt. Required: plugin_id, interfaces.
• Get Botpress plugin dereferenceds get admin plugin dereferenced Get a private Botpress plugin by ID with all interface entity references resolved to the corresponding entities as extended by the backing integrations. Returns: id, name, version, createdAt, updatedAt. Required: plugin_id.
• List List all Botpress plugin codes Get the public plugin code from the Botpress Hub for a specific platform (node or browser). Returns the plugin's bundled code for the requested platform. Required: plugin_id, platform.
• Get Botpress plugin codes get admin plugin code Get the compiled code for a Botpress workspace plugin for a specific platform (node or browser). Returns the plugin's bundled code for the requested platform. Required: plugin_id, platform.
• List List all Botpress hub interfaces List public interfaces in Botpress. Returns: id, name, version, createdAt, updatedAt. Results can be filtered by interface name and version.
• Get Get single Botpress hub interface by ID Get a single public interface in Botpress by id. Returns: id, name, version, createdAt, updatedAt. Required: id.
• Get Botpress hub interfaces get by name Get a public interface in Botpress by name and version. Returns: id, name, version, createdAt, updatedAt. Required: name, version. Version accepts a semver version, semver range, or 'latest'.
• List List all Botpress admin bots List Botpress bots with optional filtering by environment and tags. Returns: id, name, createdAt, updatedAt, deployedAt. Results can be sorted by createdAt or updatedAt in ascending or descending order.
• Create Create a Botpress admin bot Create a new bot in Botpress. Returns the created bot object including id, name, createdAt, updatedAt, and deployedAt. Required: name.
• Get Get single Botpress admin bot by ID Get a single Botpress bot by id. Returns the bot object including id, name, createdAt, updatedAt, and deployedAt. Required: id.
• Update Update a Botpress admin bot by ID Update a Botpress bot by id. Returns the updated bot object including id, name, createdAt, updatedAt, and deployedAt. Required: id.
• Delete Delete a Botpress admin bot by ID Delete a Botpress bot by id. Returns an empty 204 response on success. Required: id.
• Get Botpress admin bots get logs Retrieve Botpress bot logs within a specified time range, with optional filters for level, user, workflow, conversation, and message content. Returns: level, message, timestamp, userId, workflowId, conversationId. Required: bot_id, timeStart.
• Create Create a Botpress bot transfer Transfer a Botpress bot to another workspace. Returns the transferred bot object including id, name, createdAt, updatedAt, and deployedAt. Required: bot_id. Caller must be a Manager member of the bot's current workspace with bot-creation rights in the target workspace.
• List List all Botpress bot webchats Get the webchat embed code or shareable URL for a Botpress bot. Returns: code, url. Required: bot_id, type. The type parameter selects the output format: preconfigured, configurable, and fullscreen return embed code; sharableUrl returns a URL.
• List List all Botpress bot analytics Get bot analytics from Botpress for a specified date range. Returns the bot's analytics object containing performance metrics for the requested period. Required: bot_id, startDate, endDate.
• List List all Botpress bot action runs List action runs for a specific integration of a bot in Botpress. Returns: id, createdAt, status. Required: bot_id, integrationName.
• List List all Botpress bot issues List bot issues for a specific Botpress bot. Returns issue records including id, createdAt, and updatedAt. Required: bot_id.
• Delete Delete a Botpress bot issue by ID Delete a Botpress bot issue by id. Returns an empty 204 response on success. Required: bot_id, id.
• Action Botpress bot issues events List events for a specific Botpress bot issue. Returns: id, createdAt. Required: bot_id, issue_id.
• Get Get single Botpress bot issue by ID Get a single Botpress bot issue by id. Returns: id, createdAt, updatedAt. Required: bot_id, id.
• List List all Botpress bot versions List all saved versions for a specific Botpress bot. Returns: id. Required: bot_id.
• Create Create a Botpress bot version Create a new saved version for a specific Botpress bot. Returns: id. Required: bot_id.
• Get Get single Botpress bot version by ID Get a specific bot version by id in Botpress. Returns: id, createdAt, updatedAt. Required: bot_id, id.
• List List all Botpress bot bot jsons Download the raw bot JSON for a Botpress bot, optionally for a specific version. Returns the raw bot JSON object with bot-specific configuration fields. Required: bot_id.
• Create Create a Botpress bot publish from bot JSON Deploy a bot in Botpress using a provided raw bot JSON payload. Returns the deployed bot object including id, name, createdAt, updatedAt, and deployedAt. Required: bot_id. The Admin API has a maximum payload size of 50 MB.
• Create Create a Botpress versions deploy Deploy a version for a Botpress bot. Returns the deployed version object including id, createdAt, and updatedAt. Required: bot_id.
• List List all Botpress integration shareable IDS List existing shareable IDs for an integration installed in a Botpress bot. The shareable ID is a human-readable identifier for the crossover of a bot and an integration version, used for the integrations channel sandbox feature. Returns: id, createdAt, updatedAt. Required: bot_id, integration_id.
• Create Create a Botpress integration shareable ID Generate a shareable ID for an integration installed in a Botpress bot. The shareable ID is a human-readable identifier for the crossover of a bot and an integration version, used for the integrations channel sandbox feature. Returns: id. Required: bot_id, integration_id.
• Delete Botpress integration shareable IDS bulk delete Delete a shareable ID for an integration installed in a Botpress bot. The shareable ID is a human-readable identifier for the crossover of a bot and an integration version, used for the integrations channel sandbox feature. Returns an empty 204 response on success. Required: bot_id, integration_id.
• Delete Botpress integration sandboxed conversations bulk delete Unlink all sandboxed conversations for an integration installed in a Botpress bot (EXPERIMENTAL). Returns an empty 204 response on success. Required: bot_id, integration_id. Optionally pass integration_instance_alias to target a specific integration instance by alias, in which case integration_id is ignored.
• List List all Botpress bots baks List Bot Access Keys (BAKs) for a specific bot in Botpress. Returns: id, createdAt, updatedAt. Required: botId.
• Create Create a Botpress bots bak Create a new Bot Access Key (BAK) in Botpress. Returns: id, createdAt, updatedAt.
• Delete Delete a Botpress bots bak by ID Delete a Botpress Bot Api Key (BAK) by id. Returns: id. Required: id.
• List List all Botpress bot allowlists Get the allowlist for a specific Botpress bot. Returns the bot's allowlist configuration. Required: bot_id.
• Update Botpress bot allowlists bulk update Update the bot allowlist for a specific Botpress bot, controlling which domains are permitted to embed the bot. Returns the updated allowlist as an array of allowed domain strings. Required: bot_id.
• Create Create a Botpress workspace migrate to v 4 Migrate a Botpress workspace from v3 to v4 billing. This is an internal admin endpoint not meant for public use; its request body and response shape are not publicly documented. Required: workspace_id.
• List List all Botpress billing invoices List invoices billed to a Botpress workspace. Returns: id, createdAt, updatedAt. Required: workspace_id.
• List List all Botpress billing upcoming invoices Get the upcoming billing invoice for a Botpress workspace. Returns the upcoming invoice object with billing-specific fields defined upstream. Required: workspace_id.
• Create Create a Botpress invoices charge unpaid Charge unpaid invoices of a Botpress workspace. Required: workspace_id.
• List List all Botpress admin workspaces List Botpress workspaces the user has access to, optionally filtered by handle. Returns: id, name, handle, createdAt, updatedAt.
• Create Create a Botpress admin workspace Create a new Botpress workspace. Returns the created workspace object including id, name, createdAt, and updatedAt. Required: name.
• Get Get single Botpress admin workspace by ID Get a single Botpress workspace by id. Returns: id, name, handle, createdAt, updatedAt. Required: id.
• Update Update a Botpress admin workspace by ID Update a Botpress workspace by id. Returns the updated workspace object including id, name, createdAt, and updatedAt. Required: id.
• Delete Delete a Botpress admin workspace by ID Delete a Botpress workspace by id. Returns an empty 204 response on success. Required: id.
• List List all Botpress workspace publics Get public details of a Botpress workspace by workspace_id. Returns: id, name, handle, integrations, createdAt. Required: workspace_id.
• List List all Botpress workspace usages List workspace usages in Botpress for a given usage type (e.g., invocation_calls, ai_spend, bot_count). Returns: id, type. Required: workspace_id, type.
• List List all Botpress usages by bots Break down Botpress workspace usage by bot for a given usage type and optional period. Returns: botId. Required: workspace_id, type.
• List List all Botpress usages quota completions List workspace quota completion rates for a user in Botpress. Returns a map of workspace IDs to their highest quota completion rate, where each key is a workspace ID string and each value is the completion rate number.
• List List all Botpress workspace quotas Get a specific Botpress workspace quota by usage type. Returns: type, period. Required: workspace_id, type.
• Get Botpress workspace quotas get quotas List all Botpress workspace quotas for a specified workspace. Returns: type. Required: workspace_id.
• Update Botpress workspaces handle availabilities bulk update Check whether a workspace handle is available in Botpress. Returns a boolean indicating whether the handle is available for use. Required: handle.
• List List all Botpress workspaces publics List public workspaces in Botpress, optionally filtered by workspace IDs or a search query. Returns: id, handle, createdAt, updatedAt.
• List List all Botpress workspace audit records List audit records for a Botpress workspace, sorted from most recent to oldest. Returns: id, createdAt. Required: workspace_id.
• Get Get single Botpress workspaces preference by ID Get a workspace preference by id in Botpress. Returns: key, value. Required: id.
• Create Create a Botpress workspaces preference Set a workspace preference in Botpress. Returns: key, value. Required: preference_id, value.
• List List all Botpress admin workspace members List all members in a Botpress workspace. Returns: id, createdAt, updatedAt.
• Create Create a Botpress admin workspace member Add a member to a Botpress workspace. Returns the created workspace member including id, createdAt, and updatedAt.
• Get Get single Botpress admin workspace member by ID Get details of the currently authenticated Botpress workspace member. Returns: id, createdAt, updatedAt.
• Update Update a Botpress admin workspace member by ID Update a Botpress workspace member by id. Returns the updated workspace member object including id, role, createdAt, and updatedAt. Required: id.
• Delete Delete a Botpress admin workspace member by ID Remove a Botpress workspace member by id. Returns the deleted workspace member object including id, role, createdAt, and updatedAt. Required: id.
• List List all Botpress integrations iaks List Integration Api Keys (IAKs) for a specific Botpress integration. Returns: id, integrationId, createdAt, updatedAt. Required: integrationId.
• Create Create a Botpress integrations iak Create a new Integration Api Key (IAK) in Botpress. Returns the created IAK object including its id, createdAt, and updatedAt.
• Delete Delete a Botpress integrations iak by ID Delete an Integration Api Key (IAK) in Botpress by id. Returns the deleted IAK object including its id, createdAt, and updatedAt. Required: id.
• List List all Botpress admin integrations List Botpress integrations with filtering and sorting. Returns: id, name, version, description, createdAt, updatedAt, installCount, verificationStatus, visibility, matchedOn, actions, interfaces. Supports search and filtering by interface, bot, and dev status.
• Create Create a Botpress admin integration Create a new integration in Botpress. Returns the created integration with id, name, version, createdAt, updatedAt, and verificationStatus. Required: name, version.
• Get Get single Botpress admin integration by ID Get a single Botpress integration by id. Returns: id, name, version, description, createdAt, updatedAt, installCount, verificationStatus, visibility, matchedOn, actions, interfaces. Required: id.
• Update Update a Botpress admin integration by ID Update a Botpress integration by id. Returns the updated integration with id, name, version, createdAt, updatedAt, and verificationStatus. Required: id.
• Delete Delete a Botpress admin integration by ID Delete a Botpress integration by id. Returns an empty 204 response on success. Required: id.
• Get Botpress admin integrations get by name Get a Botpress integration by its name and version. Returns the integration object including id, name, version, description, createdAt, updatedAt, verificationStatus, visibility, installCount, interfaces, and actions. Required: name, version. Version accepts a semver version, a semver version range, or the constant string "latest".
• Get Botpress admin integrations get logs Get logs for a Botpress integration within a time range. Returns log entries with id, message, level, createdAt, userId, and conversationId. Required: integration_id, timeStart.
• Create Create a Botpress integrations validate Validate an integration creation request in Botpress. Returns the validation result for the proposed integration creation payload. No caller-supplied query or path parameters required.
• Update Botpress integration validates bulk update Validate an integration update request in Botpress by submitting the proposed changes for validation without applying them. Returns the validation result for the proposed integration update. Required: id.
• Create Create a Botpress integrations request verification Request integration verification for a Botpress integration, submitting it for the Botpress review process via the Admin API. Returns a verification request response. No caller-supplied query or path parameters are required; authentication headers are handled automatically.
• List List all Botpress admin interfaces List Botpress interfaces, optionally filtered by name and version. Returns: id, name, version, createdAt, updatedAt.
• Create Create a Botpress admin interface Create a new Botpress interface. Returns: id, name, version, createdAt, updatedAt. Required: name, version.
• Get Get single Botpress admin interface by ID Get a single Botpress interface by id. Returns: id, name, version, createdAt, updatedAt. Required: id.
• Update Update a Botpress admin interface by ID Update a Botpress interface by id. Returns: id, name, version, createdAt, updatedAt. Required: id.
• Delete Delete a Botpress admin interface by ID Delete a Botpress interface by id. Returns: id, name, version, createdAt, updatedAt. Required: id.
• Get Botpress admin interfaces get by name Get a Botpress interface by its name and version. Returns: id, name, version, createdAt, updatedAt. Required: name, version. The version parameter accepts a semver version, a semver version range, or the constant string "latest".
• List List all Botpress admin plugins List Botpress plugins in a workspace, optionally filtering by name and version. Returns: id, name, version, createdAt, updatedAt.
• Create Create a Botpress admin plugin Create a new Botpress plugin in a workspace. Returns: id, name, createdAt, updatedAt. Required: name, version.
• Get Get single Botpress admin plugin by ID Get a single Botpress plugin by id. Returns the plugin object including its id, name, version, createdAt, and updatedAt. Required: id.
• Update Update a Botpress admin plugin by ID Update a Botpress plugin by id. Returns the updated plugin object including its id, name, createdAt, and updatedAt. Required: id.
• Delete Delete a Botpress admin plugin by ID Delete a Botpress plugin by id. Returns an empty 204 response on success. Required: id.
• Get Botpress admin plugins get by name Get a single Botpress plugin by name and version. Returns: id, name, version, createdAt, updatedAt. Required: name, version. The version accepts a semver version, a semver range, or "latest".
• Get Get single Botpress admin usage by ID Get a single Botpress usage record by id (bot or workspace ID, depending on type) for a specified usage type and optional period. Returns: type, id, period, createdAt, updatedAt. Required: id, type.
• List List all Botpress admin usages List Botpress usage history for a resource (bot or workspace) by resource_id and usage type. Returns: type, id, period, createdAt, updatedAt. Required: resource_id, type.
• Action Botpress admin usages activity List Botpress usage activity for a resource (bot or workspace) by resource_id and usage type, with the most recent activity listed first. Returns: type, id, timestamp, createdAt, updatedAt. Required: resource_id, type.
• List List all Botpress usages multiples List multiple Botpress usages across several workspace or bot IDs in a single request. Returns: id, type, period. Required: types, ids. All requested types must belong to the same entity kind (workspace or bot).
• List List all Botpress usage daily activities List aggregate daily usage activity in Botpress for a given usage type and resource ID, with the most recent activity listed first. Returns daily activity records containing the date and aggregated usage count for the specified type. Required: resource_id, type.
• Update Botpress quotas AI spends bulk update Update the AI Spend quota for a Botpress workspace. Returns the updated AI spend quota object reflecting the new configuration. The request body fields are defined in the upstream OpenAPI component `changeAISpendQuotaBody`.
• List List all Botpress admin activities List activities of a Botpress task. Returns: id, createdAt, updatedAt. Required: bot_id, task_id.
• Create Create a Botpress admin introspect Introspect the Botpress Admin API to retrieve its specification. Returns the introspected API specification with dynamic, schema-specific fields. No required parameters.
• Get Get single Botpress conversation by ID Get a single Botpress conversation by id. Returns: id, createdAt, updatedAt. Required: id.
• Delete Delete a Botpress conversation by ID Permanently delete a Botpress conversation by id. Also immediately deletes corresponding messages; this cannot be undone. Returns: id, createdAt, updatedAt. Required: id.
• List List all Botpress conversations List Botpress conversations. Returns: id, createdAt, updatedAt.
• Create Create a Botpress conversation Create a new Botpress conversation. Returns: id, createdAt, updatedAt.
• List Botpress conversations list messages List messages in a Botpress conversation. Returns: id, createdAt. Required: conversation_id.
• Get Get single Botpress conversations get or create by ID Get or create a Botpress conversation by id. If a conversation with the given id already exists it is returned; otherwise a new one is created. Returns: id, createdAt, updatedAt. Required: id.
• List List all Botpress conversation listens Open an SSE stream to receive real-time messages and events from a Botpress conversation. The response is a Server-Sent Events stream rather than a JSON body with enumerable fields. Required: conversation_id.
• List List all Botpress conversation participants List participants in a Botpress conversation. Returns: id, name, pictureUrl, profile, createdAt, updatedAt. Required: conversation_id.
• Create Create a Botpress conversation participant Add a participant to a Botpress conversation by user id. Returns: id, name, pictureUrl, profile, createdAt, updatedAt. Required: conversation_id, userId.
• Delete Delete a Botpress conversation participant by ID Remove a participant from a Botpress conversation by id. Returns an empty 200 response with no data on success. Required: conversation_id, id.
• Get Get single Botpress conversation participant by ID Get a specific participant from a Botpress conversation by id. Returns: id, name, pictureUrl, profile, createdAt, updatedAt. Required: conversation_id, id.
• Get Get single Botpress message by ID Get a single Botpress message by id. Returns: id, createdAt, payload, userId, conversationId. The payload field is a content-type-specific object whose shape is determined by a `type` discriminator (audio, card, carousel, choice, dropdown, file, image, location, markdown, text, video). Required: id.
• Delete Delete a Botpress message by ID Permanently delete a Botpress message by id; this action cannot be undone. Returns the deleted Message object including its id, createdAt, payload, userId, and conversationId. Required: id.
• Create Create a Botpress message Create a new message in Botpress by sending a typed payload to a conversation webhook. Supports payload types: text, markdown, image, audio, video, file, card, carousel, choice, dropdown, and location, each with type-specific required fields. Returns: id, createdAt. Required: webhook_url, payload.
• Get Get single Botpress users get or create by ID Get or create a Botpress chat user, returning the existing user if a match is found or creating a new one otherwise. Returns: id, name, pictureUrl, profile, createdAt, updatedAt. The profile field is limited to 1000 characters.
• Get Get single Botpress event by ID Get a Botpress custom event by id. Returns: id, createdAt, payload, conversationId, userId. Required: id.
• Create Create a Botpress event Create a custom Botpress event. Returns: id, createdAt, payload, conversationId, userId. Required: payload, conversationId.
• List List all Botpress files List files uploaded to a Botpress bot with optional filtering and sorting. Returns: id, key, size, status, createdAt, updatedAt, tags, indexed. Supports sorting by key, size, createdAt, updatedAt, or status, and filtering by tags, IDs, and indexing state.
• Update Botpress files bulk update Create or update a Botpress file using key as the unique identifier; updating erases existing content. Upload file content separately via a PUT request to the uploadUrl returned in the response. Returns: id, createdAt, updatedAt. Required: key.
• Get Get single Botpress file by ID Get a Botpress file by its file ID or key. Returns the file object including id, key, size, status, createdAt, updatedAt, uploadUrl, and tags. Required: id.
• Update Update a Botpress file by ID Update metadata for a Botpress file by id (File ID or Key) without modifying the file content. Returns the updated file object including id, key, size, status, createdAt, updatedAt, tags, and accessPolicies. Required: id.
• Delete Delete a Botpress file by ID Delete a file in Botpress by its file ID or key. Returns an empty response on success. Required: id.
• Create Create a Botpress file Copy a Botpress file to a new destination key, optionally to a different bot. Returns the copied file object including id, key, size, status, and createdAt. Required: id_or_key, destination_key. The destination_key must not already be in use in the destination bot.
• Search Botpress files search Search indexed Botpress files using natural language semantic search to retrieve matching text passages. Returns: content, score, context. Required: query. Maximum 50 results; query limited to 1 KB.
• List List all Botpress file passages List indexed text passages for a Botpress file by file ID or key. Returns each passage with its content, context, breadcrumb, title, and subtitle. Required: file_id.
• Update Botpress file passages bulk update Set the indexed file passages for a Botpress file by id, replacing all existing passages asynchronously. Returns the passages array. Required: id. The endpoint returns immediately with the file status set to indexing_pending; indexing completes asynchronously, transitioning to indexing_completed or indexing_failed.
• List List all Botpress files tags List available file tags in Botpress. Returns: name.
• List List all Botpress tag values List all distinct values assigned to a specific file tag in Botpress. Returns a paginated collection of tag value strings. Required: tag.
• List List all Botpress files knowledge bases List knowledge bases for a bot in Botpress. Returns: id, name, tags, createdAt, updatedAt. Supports filtering by tags passed as a URL-encoded JSON object of key-value pairs.
• Create Create a Botpress files knowledge base Create a new knowledge base for grouping files in Botpress. Returns: id, name, tags, createdAt, updatedAt. Required: name.
• Update Update a Botpress files knowledge base by ID Update an existing knowledge base in Botpress. Returns: id, name, tags, createdAt, updatedAt. Required: id.
• Delete Delete a Botpress files knowledge base by ID Delete a knowledge base in Botpress by id. Returns an empty 204 response on success. Required: id.
• List List all Botpress chat conversations List Botpress conversations sorted by recency, with the most recent appearing first. Returns: id, createdAt, updatedAt. Filterable by tags, participant ids, integration name, channel, and creation date range; sortable by createdAt or updatedAt.
• Create Create a Botpress chat conversation Create a new Botpress conversation. Returns: id, createdAt, updatedAt. Required: tags. The required tags depend on the specific integration; see the integration's documentation for details.
• Get Get single Botpress chat conversation by ID Get a single Botpress chat conversation by id. Returns: id, createdAt, updatedAt. Required: id.
• Update Update a Botpress chat conversation by ID Update a Botpress conversation by id, setting the values of the parameters passed; any parameters not provided are left unchanged. Returns: id, createdAt, updatedAt. Required: id.
• Delete Delete a Botpress chat conversation by ID Permanently delete a Botpress chat conversation by id; this also immediately deletes all corresponding messages and cannot be undone. Returns: id, createdAt, updatedAt. Required: id.
• List List all Botpress chat events List Botpress chat events sorted by most recent first. Returns: id, createdAt, payload, conversationId, userId. Filter by type, conversationId, userId, messageId, workflowId, or status.
• Create Create a Botpress chat event Create a new Botpress chat event. Returns the created event including id, createdAt, payload, conversationId, and userId. Required: payload, conversationId.
• Get Get single Botpress chat event by ID Get a single Botpress chat event by id. Returns: id, createdAt, payload, conversationId, userId. Required: id.
• Delete Delete a Botpress events scheduled by ID Cancel a scheduled Event in Botpress. The event must be in a `scheduled` state. Returns the cancelled event object including its id, createdAt, payload, conversationId, and userId. Required: id.
• List List all Botpress chat messages List messages for a bot. Supports filtering by conversation, date range, and tags with cursor-based pagination.
• Create Create a Botpress chat message Create a new message in a conversation. Supports all Botpress payload types (text, image, card, choice, etc.) and optional scheduled delivery.
• Get Get single Botpress chat message by ID Retrieve a single message by its ID, including payload, tags, direction, and metadata.
• Update Update a Botpress chat message by ID Update the tags or payload of an existing message. The message type field is immutable and cannot be changed.
• Delete Delete a Botpress chat message by ID Permanently delete a message by its ID. This action is irreversible.
• Get Get single Botpress messages get or create by ID Retrieve an existing message matching the given discriminating tags, or create it if not found. If found, updates its tags and payload with the provided values.
• Create Create a Botpress chat initialize incoming message Initialize an incoming message by atomically get-or-creating the user, conversation, and message in a single call. Used by integrations to register inbound messages from external channels before processing them through the bot.
• Create Create a Botpress messages import message Bulk import up to 100 messages into Botpress conversations in a single call. Each message uses discriminateByTags for idempotent deduplication, making it safe to re-run imports. Used to migrate or replay historical messages from an external channel.
• List List all Botpress chat users List Botpress chat users sorted by most recent first. Returns: id, name, pictureUrl, profile, tags, attributes, createdAt, updatedAt. Filterable by conversation id, tags, and date range.
• Create Create a Botpress chat user Create a new Botpress chat user. Returns: id, name, pictureUrl, profile, createdAt, updatedAt. Required tags vary by integration; see the specific integration for details.
• Get Get single Botpress chat user by ID Get a single Botpress chat user by id. Returns: id, name, pictureUrl, profile, tags, attributes, createdAt, updatedAt. Required: id.
• Update Update a Botpress chat user by ID Update a Botpress chat user by id. Any parameters not provided will be left unchanged. Returns: id, name, createdAt, updatedAt. Required: id.
• Delete Delete a Botpress chat user by ID Permanently delete a Botpress chat user by id. This action cannot be undone. Returns: id, name, createdAt, updatedAt. Required: id.
• Create Create a Botpress expiry Update the expiry for a Botpress chat state. Returns the updated State object including type, id, name, expiresAt, createdAt, and updatedAt. Required: type, state_id, name.
• List List all Botpress chat states Get a Botpress chat state by resource type, state_id, and name. Returns the State object including type, id, name, values, expiresAt, createdAt, and updatedAt. Required: type, state_id, name.
• Create Create a Botpress chat state Override a Botpress chat state by setting new state values for a given resource type, state_id, and name. Returns the State object including type, id, name, createdAt, and updatedAt. Required: type, state_id, name.
• Update Botpress chat states bulk update Update a Botpress chat state by setting new state values for a given resource type, id, and name. Returns the State object including type, id, name, createdAt, and updatedAt. Required: type, id, name.
• Get Get single Botpress get or set by ID Get or create a Botpress chat State by resource type, id, and name — returns the existing State, or creates a new one if it does not exist. Returns: type, id, name, value, expiresAt, createdAt, updatedAt. Required: type, name, id.
• Create Create a Botpress chat action Call an action on a Botpress bot via the Chat API. Returns the action result with action-specific fields depending on which action was invoked.
• Create Create a Botpress integrations configure Configure a Botpress integration by having it call this endpoint to configure itself. Returns the configuration object with integration-specific fields.
• List List all Botpress chat workflows List Botpress chat workflows with the most recent appearing first. Returns: id, name, status, conversationId, userId, parentWorkflowId, tags, createdAt, updatedAt. Filterable by tags, conversationId, userId, parentWorkflowId, statuses, and name.
• Create Create a Botpress chat workflow Create a new Botpress chat workflow. Returns: id, name, createdAt, updatedAt.
• Get Get single Botpress chat workflow by ID Get a single Botpress chat workflow by id. Returns: id, name, status, conversationId, userId, parentWorkflowId, tags, createdAt, updatedAt. Required: id.
• Update Update a Botpress chat workflow by ID Update a Botpress chat workflow by id, setting only the provided parameters; any not provided remain unchanged. Returns: id, name, createdAt, updatedAt. Required: id.
• Delete Delete a Botpress chat workflow by ID Permanently delete a Botpress chat workflow by id. This action cannot be undone. Returns: id, name, createdAt, updatedAt. Required: id.
• Get Get single Botpress workflows get or create by ID Get an existing Botpress workflow by tags, or create a new one if no matching workflow is found. Returns: id, name, createdAt, updatedAt. Required: tags.
• Create Create a Botpress chat analytic Add an event to Botpress chat analytics. Returns the analytics response object.
• Create Create a Botpress chat observation Capture a bot runtime observation in Botpress. Returns the captured observation object. Does not support integration observations yet.
• List List all Botpress tables List all tables associated with your Botpress bot, optionally filtered by tags. Returns: id, name, schema, createdAt, updatedAt.
• Create Create a Botpress table Create a new Botpress table with a provided column schema, excluding system-managed fields like IDs and timestamps. Returns: id, name, schema, createdAt, updatedAt. Required: name, schema.
• Get Get single Botpress table by ID Get a single Botpress table by id. Returns: id, name, schema, tags, createdAt, updatedAt. Required: id.
• Update Update a Botpress table by ID Update the schema or name of an existing Botpress table. Returns: id, name, schema, createdAt, updatedAt. Required: id.
• Delete Delete a Botpress table by ID Delete a Botpress table by id, permanently removing the table and all its associated data. This action cannot be undone. Returns an empty 204 response on success. Required: id.
• Duplicate Botpress tables duplicate Duplicate a Botpress table's schema and content by source table id, creating a new table with the same structure and data. Returns: id, name, createdAt, updatedAt. Required: source_table_id.
• Get Botpress tables get or create Get or create a Botpress table by table_id. If the table exists, retrieves its information; otherwise, creates a new table based on the provided schema in the request body. Returns: id, name, schema, tags, createdAt, updatedAt. Required: table_id, schema.
• List List all Botpress table exports Starts an export job for the table. Required: table_id.
• List List all Botpress table jobs List recent export and import jobs for a Botpress table. Returns: id, type, createdAt, updatedAt. Required: table_id.
• Create Create a Botpress table import Import the content of a file into a Botpress table. The table must already exist with the correct schema; existing data in the table is preserved. Returns the import job result. Maximum payload size is 40 MB. Required: table_id, fileId.
• Update Botpress table columns bulk update Rename an existing column within a Botpress table to better reflect its content or usage. The request body must include the current column name and the new column name. Returns: id. Required: table_id, name, newName.
• List List all Botpress table rows Get a specific Botpress table row by its integer id. Returns: id, createdAt, updatedAt, data. Required: table_id, id.
• Create Create a Botpress table row Create one or more new rows in a Botpress table. Returns the created rows with id, createdAt, updatedAt, and table-schema-specific data fields. Required: table_id, rows.
• Update Botpress table rows bulk update Update specified rows in a Botpress table with partial success support and detailed error feedback. Returns the updated rows with id, createdAt, updatedAt, and table-schema-specific data fields. Required: table_id, rows.
• Create Create a Botpress rows find Search and filter rows in a Botpress table based on specific criteria, supporting complex queries for advanced data retrieval. Returns matching rows with id and table-schema-specific data. Required: table_id.
• Delete Delete a Botpress rows delete by ID Delete specific rows or clear all rows from a Botpress table. Returns the affected rows including id, createdAt, and updatedAt. Required: table_id.
• Create Create a Botpress rows upsert Upsert rows in a Botpress table by key — existing rows matching the key are updated, otherwise new rows are created. Returns the upserted rows including id, createdAt, updatedAt, and table-specific column data. Required: table_id, rows.
• Create Create a Botpress bot signing secrets rotate Rotate bot signing secrets in Botpress. Generates a new signing secret; existing secrets remain valid for 24 hours before being invalidated. Returns: id, createdAt, updatedAt. Required: bot_id.
• Create Create a Botpress integration signing secrets rotate Rotate signing secrets for a Botpress integration, generating a new secret and invalidating old ones after 24 hours. Returns: id, createdAt, updatedAt. Required: integration_id.
• List List all Botpress chat tag values List Botpress chat tag values for a given tag key. Returns an array of tag value strings associated with the given tag key. Required: key, type.

No tools match your search.