Botpress (BYOK)

Botpress (BYOK) — connector documentation

• MCP endpoint: https://byok-botpress.connectorbay.com/mcp
• REST API: POST https://byok-botpress.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-botpress.connectorbay.com/openapi.json
• Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
• Authentication: your own Botpress Botpress personal access token, sent in the X-Upstream-Key header and the workspace id (sent as x-workspace-id) in X-Upstream-Key-2 of every request (never stored, logged or cached)
• Health: https://byok-botpress.connectorbay.com/health · Tool schemas: https://byok-botpress.connectorbay.com/tools.json
• Publisher: Unify Dynamics LLC · connectorbay.com/byok-botpress · agent@connectorbay.com

What Botpress (BYOK) is for

Botpress (BYOK) lets an AI assistant read your own Botpress data through the Botpress API with a key you supply (Botpress personal access token). Read-only: 8 tools (get_account, list_workspaces, get_workspace, get_workspace_quota, list_bots, get_bot_analytics, list_bot_issues, list_integrations). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.botpress.cloud. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Botpress. Botpress and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

• "Which Botpress account is this token for?"
• "Which Botpress workspaces do I have and on which plan?"
• "How many bots does Botpress workspace X have?"
• "How much AI spend has my Botpress workspace used this month?"
• "Which Botpress bots do I have and when were they last deployed?"
• "How many sessions did my Botpress bot have last week?"

What it does

• get_account: Show the Botpress account behind the token: id, display name, email verification flag and creation time. The email address is not requested.
• list_workspaces: List the workspaces the account can access with plan, bot count, spending limit, blocked flag and creation time.
• get_workspace: Get one workspace: name, plan, bot count, spending limit, blocked flag, handle and times.
• get_workspace_quota: Get one quota of a workspace (for example bot_count, ai_spend, storage_count or invocation_calls) for a billing period.
• list_bots: List the bots of the workspace in the x-workspace-id header with name, type, tags, creation and deployment time.
• get_bot_analytics: Get daily usage analytics of a bot for a date range: new and returning users, sessions, messages and conversations created.
• list_bot_issues: List the issues Botpress detected for a bot (code errors, limits, configuration) with title, category, count and last seen time.
• list_integrations: List integrations available to the workspace with name, version, title, description, visibility and verification status.

BYOK key

You bring your own Botpress Botpress personal access token (https://app.botpress.cloud). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.botpress.cloud over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

• https://botpress.com/docs/api-reference/admin-api/getting-started (the API this connector calls, with a BYOK key)

Live from the Botpress API (api.botpress.cloud) with a BYOK key; documentation: https://botpress.com/docs/api-reference/admin-api/getting-started. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Botpress. Botpress and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Botpress account.

Built for: Worldwide. Languages: English.

Botpress (BYOK) — Privacy Policy

Effective 24 October 2026. Unify Dynamics LLC ("we", "us"), Menlo Park, California.

What Botpress (BYOK) is. Botpress (BYOK) is a connector (an MCP server and REST API) that an AI assistant calls on your behalf to read your own Botpress data: Read your Botpress workspaces, bots, bot analytics, bot issues, integrations and workspace quotas with your own personal access token. You bring your own Botpress Botpress personal access token; the assistant sends it to us with each request.

BYOK key. The key you supply is used to make the one Botpress call you asked for. Our application does not store it, write it to a log, put it in a cache, or share it. It is sent only to api.botpress.cloud, over https, and is removed from any text we return to you or your assistant. We do not follow redirects with your key. If Botpress rejects it, we say so without repeating it.

What we receive. The arguments of each tool call, the BYOK key (for that call only), the technical headers needed to serve the request (an IP address or a client identifier supplied by the assistant) and standard server logs. What Botpress receives. The request we make on your behalf, including the key and the arguments, under Botpress's own terms and privacy policy. Botpress acts at your direction and is the only recipient of the data of your request besides our hosting provider.

What we return. The answer Botpress gives for your request, trimmed to the fields the tool documents. We do not keep it: it is returned to your assistant and not stored, cached or used to train anything.

What we do not do. We do not build a profile, sell or share personal information, or keep your Botpress data. Rate-limit counters (a client identifier and timestamps) are held in memory for at most 24 hours. Hosting access logs (IP addresses, request paths and status codes) are kept for up to 30 days for security and abuse prevention; our application adds no request headers or bodies to them.

Sub-processors. Botpress (the API you call with a BYOK key, at your direction). Hosting: Vercel (United States regions).

Your rights. Because we store no personal data beyond short-lived logs, requests to access, correct or delete data are usually satisfied automatically; you can still contact agent@connectorbay.com and we will respond within 30 days. Revoke your key at Botpress at any time to end all access.

Children. Botpress (BYOK) is a general-audience service operated by the adult using the assistant, under Botpress's own age rules.

Changes. We will post changes here with a new effective date.

Botpress (BYOK) — Terms of Service

Effective 24 October 2026. These terms govern use of the Botpress (BYOK) connector ("the Service") operated by Unify Dynamics LLC ("we", "us").

1. The Service. Botpress (BYOK) provides: Read your Botpress workspaces, bots, bot analytics, bot issues, integrations and workspace quotas with your own personal access token. It is accessed through an AI assistant or directly over MCP or HTTP, and is read-only.
2. Your own key, your own account. You must use your own Botpress credentials and only access data you are allowed to access. Botpress's terms apply to your use of Botpress; you are responsible for complying with them, including any rate limits and permitted uses. Do not share a key you do not own.
3. Independent. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Botpress. Botpress and its logos are trademarks of their owners and are used only to say which service the connector works with.
4. No advice, no guarantees. Output is the data Botpress returns, lightly trimmed; it may be incomplete, delayed or changed by Botpress. Check important facts at the source.
5. Read-only. The Service does not create, change, send or delete anything in your Botpress account.
6. Acceptable use. Automated use within the published rate limits is welcome. Do not use the Service to access data you are not entitled to, to circumvent Botpress's controls, or to attack any system.
7. Availability. The Service is provided "as is" without warranty. We may change, limit or discontinue it at any time; Botpress may change or end its API at any time.
8. Data. Our Privacy Policy describes what we process. In short: the BYOK key is used for the one call and not stored or logged.
9. Pro keys. Optional ConnectorBay Pro API keys are issued at our discretion and are separate from your Botpress key.
10. Liability. To the fullest extent permitted by law, Unify Dynamics LLC is not liable for any loss arising from use of or reliance on the Service, including any action Botpress takes on your account. Our total liability is limited to US $100.
11. Governing law. California law; venue in San Mateo County, California.
12. Contact. Unify Dynamics LLC · agent@connectorbay.com · https://connectorbay.com/byok-botpress

Botpress (BYOK) support

Email agent@connectorbay.com. We answer within two business days.

• MCP endpoint: https://byok-botpress.connectorbay.com/mcp
• REST API: https://byok-botpress.connectorbay.com/openapi.json
• Live status: https://byok-botpress.connectorbay.com/health

When you report a problem, include the question you asked your agent, roughly when, and which agent you used (for example Claude, ChatGPT or Gemini). Never send us passwords, account numbers or ID numbers. Botpress (BYOK) never asks for them.