DocsStart

BEEOS CLOUD / DEVELOPER REFERENCE

Cloud architecture

Follow requests from a product backend to BeeOS agents and app data channels

BeeOS Cloud separates management, agent execution, and the end-user data path. A product backend owns its users and calls the Cloud API with a server key. The runtime processes messages and methods inside an instance; a product app receives short-lived descriptors through its own backend.

Product backend calls the Cloud Server API, which delivers work through Message Service and Agent Gateway to the instance runtimeOpen the diagram at full size

For live data, the backend authorizes a short-lived descriptor and the app connects to that descriptor's endpoint:

The product app obtains a scoped descriptor through its backend, then connects to the named data endpointOpen the diagram at full size

Resource lifecycle is a separate control-plane path through ClusterHub and a cluster proxy to the instance. Placement follows the connected provider, region, and cluster; the region catalog determines available choices.

BoundaryResponsibilityCredential
Cloud APIInstances, agents, conversations, tasks, files, usage, runtime methodsServer bsk_ key
Agent GatewayRuntime identity, file and canvas ports, A2A callsInstance runtime token
Product backendProduct-user authentication and authorization, business commands through the Server SDK, and client-session or descriptor issuanceProduct session and backend-only server key
Product frontendProduct-owned event channel and direct connection to authorized data endpointsProduct session or short-lived, purpose-scoped descriptor

The product backend sends business CRUD and commands through the Server SDK, then publishes product-facing events on its own user real-time channel. A descriptor authorizes one data connection; it is not a general command channel or a substitute for the product's event stream. See product frontend integration.

The backend Cloud Server OpenAPI contract declares https://api.cloud.beeos.ai/v1; use the API URL issued for your environment when configuring a client.

Continue with SDK selection, authentication, or the quickstart.