# Botpress MCP connector

The Botpress connector brings your bots, admin accounts, access tokens and hub plugins into Claude, ChatGPT and Cursor through one governed endpoint, so each person works inside their own Botpress access with every action logged.

Source: https://elaichi.ai/connectors/botpress/

## Facts

| | |
| --- | --- |
| Application | Botpress |
| Category | Artificial Intelligence |
| AI tools | 198 |
| Authentication | Connects with an API key |
| Needs your own OAuth app | No |
| MCP endpoint | https://api.elaichi.ai/mcp |
| Works with | Claude, ChatGPT, Cursor, any MCP client, and the Elaichi Agent |
| Tools advertised by name | No. 198 tools is past the 30-tool threshold, so clients use `search_tools` and `execute_tool` |

## What you can ask once Botpress is connected

- List all Botpress hub integrations added this month.
- Which admin accounts hold active Botpress account PATs?
- Show Botpress hub plugins used by the support bot.

## Connect Botpress in Elaichi

This happens once for the organization, before any client is involved.

1. Open Connections, choose Add connection, and pick Botpress.
2. Optionally set Share with, then press Connect.
3. Paste a Botpress API key. One person generates a token in Botpress and pastes it once. Everyone else works through Share with, and never sees it.

Credentials are vaulted and nobody, including the AI, reads them back. The connection becomes a toolbox immediately, so you can curate which Botpress tools are exposed, rename them, or freeze arguments before anyone points a client at it.

## Connect Botpress to Claude

Endpoint: https://api.elaichi.ai/mcp

1. Open Customize, then Connectors.
2. Press Add.
3. Name it, paste the MCP server URL, then Continue.
4. Sign in and approve.

On Team and Enterprise, an Owner adds it once. Everyone else turns it on for themselves.

## Connect Botpress to ChatGPT

Endpoint: https://api.elaichi.ai/mcp

1. Open Plugins, then press the + button.
2. Name it and paste the endpoint into Server URL.
3. Leave Authentication on OAuth, then tick the risk acknowledgement.
4. Press Create, then sign in and approve.

Works on the web today. The plugin directory lives at chatgpt.com/plugins.

## Connect Botpress to Cursor

Endpoint: https://api.elaichi.ai/mcp

1. Open `~/.cursor/mcp.json`.
2. Add the endpoint under `mcpServers`.
3. Reload Cursor, then sign in and approve.

Set up per machine, so repeat it on each computer you work from.

## Connect Botpress to any MCP client

Endpoint: https://api.elaichi.ai/mcp

1. Add the endpoint as a remote MCP server.
2. Sign in and approve.

The Elaichi Agent already has these tools, with nothing to set up.

## What the consent screen decides

Only Read is granted by default, which is not enough to call a Botpress tool. Over MCP there is no trusted place to confirm a write in the moment, so the consent screen is the standing approval rather than a formality. Grant Read and Run tools. Think hard before granting Delete, which reaches into connected apps and cannot be undone.

## What teams do with Botpress through Elaichi

### Spin up a bot for a new queue

Support. Ask for a new Botpress bot when a product line or region gets its own support desk, then check it appears in the bot list alongside the ones already running.

### Audit who holds admin access

IT. Pull the full list of Botpress admin accounts before a quarterly review, spot accounts that belong to people who have moved on, and remove them by ID.

### Clean up stale personal access tokens

Security. List every personal access token on the Botpress account, retire the ones nobody recognizes, and issue a fresh token for a new automation without opening the console.

### Browse the hub before you build

Product. Look up Botpress hub plugins and interfaces by name to see what already exists before the team commits a sprint to building the same thing.

### Keep the bot inventory straight

Operations. Get a plain list of every Botpress bot in the workspace with its ID, so the runbook and the on-call sheet match what is actually deployed.

### Update many accounts in one pass

Workspace admins. Apply the same change across a batch of Botpress admin accounts at once, and set account preferences for new starters so their workspace looks right on day one.

## Frequently asked questions

### How do I connect Botpress to Claude?

First, connect Botpress inside Elaichi by pasting a Botpress API key when asked, which takes about a minute. There is no OAuth application to register and no client ID or secret to generate. Then in Claude open Customize, then Connectors, then Add, and paste https://api.elaichi.ai/mcp. Sign in with your Elaichi account and Botpress is available in the conversation.

### Does Botpress work with ChatGPT and Cursor as well as Claude?

Yes. Botpress connects to Elaichi once, and the same endpoint, https://api.elaichi.ai/mcp, is added to Claude, ChatGPT, Cursor, any other MCP client and the Elaichi Agent. You do not repeat the Botpress setup for each client, and every client follows the same restrictions and writes to the same audit log.

### What can an AI agent actually do with my Botpress data?

With Botpress connected, an agent can list your bots and create new ones, show every admin account and remove or update them, manage personal access tokens and account preferences, and look up plugins and interfaces in the Botpress hub by name. Because Botpress exposes a large number of actions, the agent searches for the right one as you ask, so short concrete requests such as "list all admin accounts" work better than long paragraphs.

### Does connecting Botpress give the AI access to my whole workspace?

No. Access follows the person who signed in, so an agent working through Botpress sees only the bots, accounts and tokens that person's Botpress API key can already reach. Elaichi can narrow that further, for example by hiding deletions from a team, but it can never widen what Botpress itself allows.

### Can my team share one Botpress connection?

Yes. One administrator connects Botpress in Elaichi and shares the connection with a team, and nobody else ever handles the Botpress API key. Each teammate still signs in to Elaichi as themselves, so the audit log names the person who listed the accounts or created the bot, not a shared login.

### Can I stop an agent from deleting or changing things in Botpress?

Yes. Restrictions in Elaichi apply per action, so you can allow listing Botpress bots and accounts while blocking deletion of admin accounts or tokens. A blocked action is never shown to Claude, ChatGPT or any other client at all, so no prompt, however worded, can reach it.

### What happens to a Botpress connection when someone leaves?

Offboarding a person in Elaichi ends their access to Botpress through every connected client at once, with nothing to revoke in Claude or ChatGPT separately. If they connected a shared Botpress account, it keeps working for everyone else on the team. Disconnecting Botpress once in Elaichi removes it from every client for everyone.

## All 198 Botpress tools

Every tool below is callable through https://api.elaichi.ai/mcp once Botpress is connected, subject to the toolbox it is in and the restrictions on the caller.

- **Create a Botpress helper vrl** (Create). Run a VRL (Vector Remap Language) script in Botpress. Returns the result of the script execution.
- **Delete a Botpress admin account by ID** (Delete). Delete the Botpress account associated with the authenticated user. Returns: id, name, createdAt, updatedAt.
- **List all Botpress admin accounts** (List). Retrieve the current authenticated account's profile, including email, display name, email verification status, and profile picture.
- **Botpress admin accounts bulk update** (Update). Update details of the Botpress account associated with the authenticated user. Returns: id, name, createdAt, updatedAt.
- **List all Botpress account pats** (List). List Personal Access Tokens (PATs) for the authenticated Botpress account. Returns: id, createdAt, updatedAt.
- **Create a Botpress account pat** (Create). Create a new Personal Access Token (PAT) in Botpress. Returns: id, createdAt, updatedAt.
- **Delete a Botpress account pat by ID** (Delete). Delete a Personal Access Token (PAT) by id. Required: id. Returns an empty 204 response on success.
- **Get single Botpress account preference by ID** (Get). Get a Botpress account preference by its preference key. Returns the preference object including its key and value. Required: id.
- **Create a Botpress account preference** (Create). 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 all Botpress hub integrations** (List). 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 single Botpress hub integration by ID** (Get). 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.
- **Botpress hub integrations get by name** (Get). 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 all Botpress hub plugins** (List). List public plugins from the Botpress Hub, optionally filtered by name and/or version. Returns: id, name, version, createdAt, updatedAt.
- **Get single Botpress hub plugin by ID** (Get). Get a single public plugin from the Botpress Hub by id. Returns: id, name, version, createdAt, updatedAt. Required: id.
- **Botpress hub plugins get by name** (Get). 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 all Botpress plugin dereferenceds** (List). 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.
- **Botpress plugin dereferenceds get admin plugin dereferenced** (Get). 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 all Botpress plugin codes** (List). 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.
- **Botpress plugin codes get admin plugin code** (Get). 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 all Botpress hub interfaces** (List). List public interfaces in Botpress. Returns: id, name, version, createdAt, updatedAt. Results can be filtered by interface name and version.
- **Get single Botpress hub interface by ID** (Get). Get a single public interface in Botpress by id. Returns: id, name, version, createdAt, updatedAt. Required: id.
- **Botpress hub interfaces get by name** (Get). 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 all Botpress admin bots** (List). 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 a Botpress admin bot** (Create). Create a new bot in Botpress. Returns the created bot object including id, name, createdAt, updatedAt, and deployedAt. Required: name.
- **Get single Botpress admin bot by ID** (Get). Get a single Botpress bot by id. Returns the bot object including id, name, createdAt, updatedAt, and deployedAt. Required: id.
- **Update a Botpress admin bot by ID** (Update). Update a Botpress bot by id. Returns the updated bot object including id, name, createdAt, updatedAt, and deployedAt. Required: id.
- **Delete a Botpress admin bot by ID** (Delete). Delete a Botpress bot by id. Returns an empty 204 response on success. Required: id.
- **Botpress admin bots get logs** (Get). 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 a Botpress bot transfer** (Create). 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 all Botpress bot webchats** (List). 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 all Botpress bot analytics** (List). 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 all Botpress bot action runs** (List). List action runs for a specific integration of a bot in Botpress. Returns: id, createdAt, status. Required: bot_id, integrationName.
- **List all Botpress bot issues** (List). List bot issues for a specific Botpress bot. Returns issue records including id, createdAt, and updatedAt. Required: bot_id.
- **Delete a Botpress bot issue by ID** (Delete). Delete a Botpress bot issue by id. Returns an empty 204 response on success. Required: bot_id, id.
- **Botpress bot issues events** (Action). List events for a specific Botpress bot issue. Returns: id, createdAt. Required: bot_id, issue_id.
- **Get single Botpress bot issue by ID** (Get). Get a single Botpress bot issue by id. Returns: id, createdAt, updatedAt. Required: bot_id, id.
- **List all Botpress bot versions** (List). List all saved versions for a specific Botpress bot. Returns: id. Required: bot_id.
- **Create a Botpress bot version** (Create). Create a new saved version for a specific Botpress bot. Returns: id. Required: bot_id.
- **Get single Botpress bot version by ID** (Get). Get a specific bot version by id in Botpress. Returns: id, createdAt, updatedAt. Required: bot_id, id.
- **List all Botpress bot bot jsons** (List). 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 a Botpress bot publish from bot JSON** (Create). 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 a Botpress versions deploy** (Create). Deploy a version for a Botpress bot. Returns the deployed version object including id, createdAt, and updatedAt. Required: bot_id.
- **List all Botpress integration shareable IDS** (List). 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 a Botpress integration shareable ID** (Create). 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.
- **Botpress integration shareable IDS bulk delete** (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.
- **Botpress integration sandboxed conversations bulk delete** (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 all Botpress bots baks** (List). List Bot Access Keys (BAKs) for a specific bot in Botpress. Returns: id, createdAt, updatedAt. Required: botId.
- **Create a Botpress bots bak** (Create). Create a new Bot Access Key (BAK) in Botpress. Returns: id, createdAt, updatedAt.
- **Delete a Botpress bots bak by ID** (Delete). Delete a Botpress Bot Api Key (BAK) by id. Returns: id. Required: id.
- **List all Botpress bot allowlists** (List). Get the allowlist for a specific Botpress bot. Returns the bot's allowlist configuration. Required: bot_id.
- **Botpress bot allowlists bulk update** (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 a Botpress workspace migrate to v 4** (Create). 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 all Botpress billing invoices** (List). List invoices billed to a Botpress workspace. Returns: id, createdAt, updatedAt. Required: workspace_id.
- **List all Botpress billing upcoming invoices** (List). Get the upcoming billing invoice for a Botpress workspace. Returns the upcoming invoice object with billing-specific fields defined upstream. Required: workspace_id.
- **Create a Botpress invoices charge unpaid** (Create). Charge unpaid invoices of a Botpress workspace. Required: workspace_id.
- **List all Botpress admin workspaces** (List). List Botpress workspaces the user has access to, optionally filtered by handle. Returns: id, name, handle, createdAt, updatedAt.
- **Create a Botpress admin workspace** (Create). Create a new Botpress workspace. Returns the created workspace object including id, name, createdAt, and updatedAt. Required: name.
- **Get single Botpress admin workspace by ID** (Get). Get a single Botpress workspace by id. Returns: id, name, handle, createdAt, updatedAt. Required: id.
- **Update a Botpress admin workspace by ID** (Update). Update a Botpress workspace by id. Returns the updated workspace object including id, name, createdAt, and updatedAt. Required: id.
- **Delete a Botpress admin workspace by ID** (Delete). Delete a Botpress workspace by id. Returns an empty 204 response on success. Required: id.
- **List all Botpress workspace publics** (List). Get public details of a Botpress workspace by workspace_id. Returns: id, name, handle, integrations, createdAt. Required: workspace_id.
- **List all Botpress workspace usages** (List). 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 all Botpress usages by bots** (List). Break down Botpress workspace usage by bot for a given usage type and optional period. Returns: botId. Required: workspace_id, type.
- **List all Botpress usages quota completions** (List). 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 all Botpress workspace quotas** (List). Get a specific Botpress workspace quota by usage type. Returns: type, period. Required: workspace_id, type.
- **Botpress workspace quotas get quotas** (Get). List all Botpress workspace quotas for a specified workspace. Returns: type. Required: workspace_id.
- **Botpress workspaces handle availabilities bulk update** (Update). Check whether a workspace handle is available in Botpress. Returns a boolean indicating whether the handle is available for use. Required: handle.
- **List all Botpress workspaces publics** (List). List public workspaces in Botpress, optionally filtered by workspace IDs or a search query. Returns: id, handle, createdAt, updatedAt.
- **List all Botpress workspace audit records** (List). List audit records for a Botpress workspace, sorted from most recent to oldest. Returns: id, createdAt. Required: workspace_id.
- **Get single Botpress workspaces preference by ID** (Get). Get a workspace preference by id in Botpress. Returns: key, value. Required: id.
- **Create a Botpress workspaces preference** (Create). Set a workspace preference in Botpress. Returns: key, value. Required: preference_id, value.
- **List all Botpress admin workspace members** (List). List all members in a Botpress workspace. Returns: id, createdAt, updatedAt.
- **Create a Botpress admin workspace member** (Create). Add a member to a Botpress workspace. Returns the created workspace member including id, createdAt, and updatedAt.
- **Get single Botpress admin workspace member by ID** (Get). Get details of the currently authenticated Botpress workspace member. Returns: id, createdAt, updatedAt.
- **Update a Botpress admin workspace member by ID** (Update). Update a Botpress workspace member by id. Returns the updated workspace member object including id, role, createdAt, and updatedAt. Required: id.
- **Delete a Botpress admin workspace member by ID** (Delete). Remove a Botpress workspace member by id. Returns the deleted workspace member object including id, role, createdAt, and updatedAt. Required: id.
- **List all Botpress integrations iaks** (List). List Integration Api Keys (IAKs) for a specific Botpress integration. Returns: id, integrationId, createdAt, updatedAt. Required: integrationId.
- **Create a Botpress integrations iak** (Create). Create a new Integration Api Key (IAK) in Botpress. Returns the created IAK object including its id, createdAt, and updatedAt.
- **Delete a Botpress integrations iak by ID** (Delete). Delete an Integration Api Key (IAK) in Botpress by id. Returns the deleted IAK object including its id, createdAt, and updatedAt. Required: id.
- **List all Botpress admin integrations** (List). 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 a Botpress admin integration** (Create). Create a new integration in Botpress. Returns the created integration with id, name, version, createdAt, updatedAt, and verificationStatus. Required: name, version.
- **Get single Botpress admin integration by ID** (Get). Get a single Botpress integration by id. Returns: id, name, version, description, createdAt, updatedAt, installCount, verificationStatus, visibility, matchedOn, actions, interfaces. Required: id.
- **Update a Botpress admin integration by ID** (Update). Update a Botpress integration by id. Returns the updated integration with id, name, version, createdAt, updatedAt, and verificationStatus. Required: id.
- **Delete a Botpress admin integration by ID** (Delete). Delete a Botpress integration by id. Returns an empty 204 response on success. Required: id.
- **Botpress admin integrations get by name** (Get). 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".
- **Botpress admin integrations get logs** (Get). 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 a Botpress integrations validate** (Create). 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.
- **Botpress integration validates bulk update** (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 a Botpress integrations request verification** (Create). 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 all Botpress admin interfaces** (List). List Botpress interfaces, optionally filtered by name and version. Returns: id, name, version, createdAt, updatedAt.
- **Create a Botpress admin interface** (Create). Create a new Botpress interface. Returns: id, name, version, createdAt, updatedAt. Required: name, version.
- **Get single Botpress admin interface by ID** (Get). Get a single Botpress interface by id. Returns: id, name, version, createdAt, updatedAt. Required: id.
- **Update a Botpress admin interface by ID** (Update). Update a Botpress interface by id. Returns: id, name, version, createdAt, updatedAt. Required: id.
- **Delete a Botpress admin interface by ID** (Delete). Delete a Botpress interface by id. Returns: id, name, version, createdAt, updatedAt. Required: id.
- **Botpress admin interfaces get by name** (Get). 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 all Botpress admin plugins** (List). List Botpress plugins in a workspace, optionally filtering by name and version. Returns: id, name, version, createdAt, updatedAt.
- **Create a Botpress admin plugin** (Create). Create a new Botpress plugin in a workspace. Returns: id, name, createdAt, updatedAt. Required: name, version.
- **Get single Botpress admin plugin by ID** (Get). Get a single Botpress plugin by id. Returns the plugin object including its id, name, version, createdAt, and updatedAt. Required: id.
- **Update a Botpress admin plugin by ID** (Update). Update a Botpress plugin by id. Returns the updated plugin object including its id, name, createdAt, and updatedAt. Required: id.
- **Delete a Botpress admin plugin by ID** (Delete). Delete a Botpress plugin by id. Returns an empty 204 response on success. Required: id.
- **Botpress admin plugins get by name** (Get). 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 single Botpress admin usage by ID** (Get). 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 all Botpress admin usages** (List). 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.
- **Botpress admin usages activity** (Action). 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 all Botpress usages multiples** (List). 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 all Botpress usage daily activities** (List). 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.
- **Botpress quotas AI spends bulk update** (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 all Botpress admin activities** (List). List activities of a Botpress task. Returns: id, createdAt, updatedAt. Required: bot_id, task_id.
- **Create a Botpress admin introspect** (Create). Introspect the Botpress Admin API to retrieve its specification. Returns the introspected API specification with dynamic, schema-specific fields. No required parameters.
- **Get single Botpress conversation by ID** (Get). Get a single Botpress conversation by id. Returns: id, createdAt, updatedAt. Required: id.
- **Delete a Botpress conversation by ID** (Delete). Permanently delete a Botpress conversation by id. Also immediately deletes corresponding messages; this cannot be undone. Returns: id, createdAt, updatedAt. Required: id.
- **List all Botpress conversations** (List). List Botpress conversations. Returns: id, createdAt, updatedAt.
- **Create a Botpress conversation** (Create). Create a new Botpress conversation. Returns: id, createdAt, updatedAt.
- **Botpress conversations list messages** (List). List messages in a Botpress conversation. Returns: id, createdAt. Required: conversation_id.
- **Get single Botpress conversations get or create by ID** (Get). 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 all Botpress conversation listens** (List). 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 all Botpress conversation participants** (List). List participants in a Botpress conversation. Returns: id, name, pictureUrl, profile, createdAt, updatedAt. Required: conversation_id.
- **Create a Botpress conversation participant** (Create). Add a participant to a Botpress conversation by user id. Returns: id, name, pictureUrl, profile, createdAt, updatedAt. Required: conversation_id, userId.
- **Delete a Botpress conversation participant by ID** (Delete). Remove a participant from a Botpress conversation by id. Returns an empty 200 response with no data on success. Required: conversation_id, id.
- **Get single Botpress conversation participant by ID** (Get). Get a specific participant from a Botpress conversation by id. Returns: id, name, pictureUrl, profile, createdAt, updatedAt. Required: conversation_id, id.
- **Get single Botpress message by ID** (Get). 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 a Botpress message by ID** (Delete). 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 a Botpress message** (Create). 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 single Botpress users get or create by ID** (Get). 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 single Botpress event by ID** (Get). Get a Botpress custom event by id. Returns: id, createdAt, payload, conversationId, userId. Required: id.
- **Create a Botpress event** (Create). Create a custom Botpress event. Returns: id, createdAt, payload, conversationId, userId. Required: payload, conversationId.
- **List all Botpress files** (List). 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.
- **Botpress files bulk update** (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 single Botpress file by ID** (Get). 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 a Botpress file by ID** (Update). 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 a Botpress file by ID** (Delete). Delete a file in Botpress by its file ID or key. Returns an empty response on success. Required: id.
- **Create a Botpress file** (Create). 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.
- **Botpress files search** (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 all Botpress file passages** (List). 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.
- **Botpress file passages bulk update** (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 all Botpress files tags** (List). List available file tags in Botpress. Returns: name.
- **List all Botpress tag values** (List). List all distinct values assigned to a specific file tag in Botpress. Returns a paginated collection of tag value strings. Required: tag.
- **List all Botpress files knowledge bases** (List). 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 a Botpress files knowledge base** (Create). Create a new knowledge base for grouping files in Botpress. Returns: id, name, tags, createdAt, updatedAt. Required: name.
- **Update a Botpress files knowledge base by ID** (Update). Update an existing knowledge base in Botpress. Returns: id, name, tags, createdAt, updatedAt. Required: id.
- **Delete a Botpress files knowledge base by ID** (Delete). Delete a knowledge base in Botpress by id. Returns an empty 204 response on success. Required: id.
- **List all Botpress chat conversations** (List). 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 a Botpress chat conversation** (Create). 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 single Botpress chat conversation by ID** (Get). Get a single Botpress chat conversation by id. Returns: id, createdAt, updatedAt. Required: id.
- **Update a Botpress chat conversation by ID** (Update). 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 a Botpress chat conversation by ID** (Delete). 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 all Botpress chat events** (List). 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 a Botpress chat event** (Create). Create a new Botpress chat event. Returns the created event including id, createdAt, payload, conversationId, and userId. Required: payload, conversationId.
- **Get single Botpress chat event by ID** (Get). Get a single Botpress chat event by id. Returns: id, createdAt, payload, conversationId, userId. Required: id.
- **Delete a Botpress events scheduled by ID** (Delete). 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 all Botpress chat messages** (List). List messages for a bot. Supports filtering by conversation, date range, and tags with cursor-based pagination.
- **Create a Botpress chat message** (Create). Create a new message in a conversation. Supports all Botpress payload types (text, image, card, choice, etc.) and optional scheduled delivery.
- **Get single Botpress chat message by ID** (Get). Retrieve a single message by its ID, including payload, tags, direction, and metadata.
- **Update a Botpress chat message by ID** (Update). Update the tags or payload of an existing message. The message type field is immutable and cannot be changed.
- **Delete a Botpress chat message by ID** (Delete). Permanently delete a message by its ID. This action is irreversible.
- **Get single Botpress messages get or create by ID** (Get). 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 a Botpress chat initialize incoming message** (Create). 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 a Botpress messages import message** (Create). 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 all Botpress chat users** (List). 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 a Botpress chat user** (Create). 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 single Botpress chat user by ID** (Get). Get a single Botpress chat user by id. Returns: id, name, pictureUrl, profile, tags, attributes, createdAt, updatedAt. Required: id.
- **Update a Botpress chat user by ID** (Update). Update a Botpress chat user by id. Any parameters not provided will be left unchanged. Returns: id, name, createdAt, updatedAt. Required: id.
- **Delete a Botpress chat user by ID** (Delete). Permanently delete a Botpress chat user by id. This action cannot be undone. Returns: id, name, createdAt, updatedAt. Required: id.
- **Create a Botpress expiry** (Create). 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 all Botpress chat states** (List). 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 a Botpress chat state** (Create). 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.
- **Botpress chat states bulk update** (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 single Botpress get or set by ID** (Get). 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 a Botpress chat action** (Create). 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 a Botpress integrations configure** (Create). Configure a Botpress integration by having it call this endpoint to configure itself. Returns the configuration object with integration-specific fields.
- **List all Botpress chat workflows** (List). 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 a Botpress chat workflow** (Create). Create a new Botpress chat workflow. Returns: id, name, createdAt, updatedAt.
- **Get single Botpress chat workflow by ID** (Get). Get a single Botpress chat workflow by id. Returns: id, name, status, conversationId, userId, parentWorkflowId, tags, createdAt, updatedAt. Required: id.
- **Update a Botpress chat workflow by ID** (Update). 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 a Botpress chat workflow by ID** (Delete). Permanently delete a Botpress chat workflow by id. This action cannot be undone. Returns: id, name, createdAt, updatedAt. Required: id.
- **Get single Botpress workflows get or create by ID** (Get). 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 a Botpress chat analytic** (Create). Add an event to Botpress chat analytics. Returns the analytics response object.
- **Create a Botpress chat observation** (Create). Capture a bot runtime observation in Botpress. Returns the captured observation object. Does not support integration observations yet.
- **List all Botpress tables** (List). List all tables associated with your Botpress bot, optionally filtered by tags. Returns: id, name, schema, createdAt, updatedAt.
- **Create a Botpress table** (Create). 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 single Botpress table by ID** (Get). Get a single Botpress table by id. Returns: id, name, schema, tags, createdAt, updatedAt. Required: id.
- **Update a Botpress table by ID** (Update). Update the schema or name of an existing Botpress table. Returns: id, name, schema, createdAt, updatedAt. Required: id.
- **Delete a Botpress table by ID** (Delete). 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.
- **Botpress tables duplicate** (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.
- **Botpress tables get or create** (Get). 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 all Botpress table exports** (List). Starts an export job for the table. Required: table_id.
- **List all Botpress table jobs** (List). List recent export and import jobs for a Botpress table. Returns: id, type, createdAt, updatedAt. Required: table_id.
- **Create a Botpress table import** (Create). 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.
- **Botpress table columns bulk update** (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 all Botpress table rows** (List). Get a specific Botpress table row by its integer id. Returns: id, createdAt, updatedAt, data. Required: table_id, id.
- **Create a Botpress table row** (Create). 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.
- **Botpress table rows bulk update** (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 a Botpress rows find** (Create). 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 a Botpress rows delete by ID** (Delete). Delete specific rows or clear all rows from a Botpress table. Returns the affected rows including id, createdAt, and updatedAt. Required: table_id.
- **Create a Botpress rows upsert** (Create). 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 a Botpress bot signing secrets rotate** (Create). 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 a Botpress integration signing secrets rotate** (Create). 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 all Botpress chat tag values** (List). 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.
