Beam Cloud (BYOK) — connector documentation
- MCP endpoint:
https://byok-beam-cloud.connectorbay.com/mcp - REST API:
POST https://byok-beam-cloud.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec athttps://byok-beam-cloud.connectorbay.com/openapi.json - Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
- Authentication: your own Beam Cloud Beam workspace token, sent in the
X-Upstream-Keyheader of every request (never stored, logged or cached) - Health:
https://byok-beam-cloud.connectorbay.com/health· Tool schemas:https://byok-beam-cloud.connectorbay.com/tools.json - Publisher: Unify Dynamics LLC · connectorbay.com/byok-beam-cloud · agent@connectorbay.com
What Beam Cloud (BYOK) is for
Beam Cloud (BYOK) lets an AI assistant read your own Beam Cloud data through the Beam Cloud API with a key you supply (Beam workspace token). Read-only: 7 tools (list_deployments, list_containers, list_tasks, list_pools, list_workers, list_machines, get_workspace_config). 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 app.beam.cloud. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Beam Cloud. Beam Cloud 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 Beam deployments are active?"
- "Which Beam containers are running right now?"
- "Did the latest Beam tasks finish successfully?"
- "Which Beam worker pools exist and what GPUs do they have?"
- "How much free GPU capacity do my Beam workers have?"
- "Which machines are registered in my Beam pool?"
What it does
list_deployments: List deployments (endpoints, task queues, functions) with name, type, active flag, version, workspace and dates.list_containers: List running and scheduled containers with status, scheduling and start times, worker, machine and deployment.list_tasks: List recent tasks with status, container, start and end times, function name and dates, plus the total count.list_pools: List worker pools with GPU type, active flag, free-capacity targets and default worker size.list_workers: List workers with status, total and free CPU, memory and GPU, pool and machine.list_machines: List external machines registered with a pool: CPU, memory, GPU, status, provider and last keepalive (registration tokens are not returned).get_workspace_config: Show the workspace id and the gateway host, port and TLS settings used for HTTP and gRPC.
BYOK key
You bring your own Beam Cloud Beam workspace token (https://docs.beam.cloud/v2/getting-started/authentication). 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 app.beam.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://docs.beam.cloud/v2/reference/platform-api (the API this connector calls, with a BYOK key)
Live from the Beam Cloud API (app.beam.cloud) with a BYOK key; documentation: https://docs.beam.cloud/v2/reference/platform-api. 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 Beam Cloud. Beam Cloud 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 Beam Cloud account.
Built for: Worldwide. Languages: English.