This reference is currently available in English. The Cloud console remains in your selected language.
BEEOS CLOUD / DEVELOPER REFERENCE
Runtime methods
Invoke instance scoped agent, skill, model, automation, MCP, session, and canvas operations
Server SDK 2.0.0 exposes cloud.methods.getCapabilities and cloud.methods.invoke on the configured Cloud URL. Capabilities describe the running framework; invoke the instance-scoped method your task needs. The SDK supplies authentication, user scope, JSON-RPC, and Idempotency-Key.
import { BeeOSClient } from "@beeos-ai/cloud-sdk";
const cloud = new BeeOSClient({
baseURL: process.env.BEEOS_CLOUD_API_URL!,
apiKey: process.env.BEEOS_API_KEY!,
}).withExternalUser(process.env.BEEOS_EXTERNAL_USER_ID!);
const instanceId = process.env.BEEOS_INSTANCE_ID!;
const capabilities = await cloud.methods.getCapabilities(instanceId);
console.log(capabilities.manifestId);
const result = await cloud.methods.invoke(
instanceId, "skills/list", {}, crypto.randomUUID(),
);
console.log(result.result, result.error);| Family | Exact method names |
|---|---|
| Agents | agent/create, agent/update, agent/delete, agent/applyTemplate |
| Skills | skills/list, skills/install, skills/update, skills/uninstall |
| Models | models/list |
| Automation | cron/list, cron/status, cron/add, cron/update, cron/remove, cron/run, cron/runs |
| MCP setup | mcp/list, mcp/prepare, mcp/set, mcp/unset |
| Sessions | session/set_mode, session/set_model, session/clear, session/cancel |
| Canvas | canvas/toggle, canvas/clear, canvas/reference, canvas/dimensions |
The second TypeScript example continues with cloud and instanceId from the first, using the real cloud.instances.open(id) handle. Python and Go use their typed JSON-RPC request models. These calls use GET /v1/instances/{instanceId}/runtime-capabilities and POST /v1/instances/{instanceId}/methods; no separate gateway URL is needed. The host’s Harness adapter dispatches methods to the running process. See Harness SDK and models.