文档服务端 SDK

BEEOS CLOUD / DEVELOPER REFERENCE

运行时方法

调用实例内的智能体、技能、模型、自动化、MCP、会话与 Canvas 操作

服务端 SDK 2.0.0 在当前 Cloud URL 上提供 cloud.methods.getCapabilities 和 cloud.methods.invoke。能力文档描述运行中的框架;按任务需要调用实例内方法。SDK 自动处理认证、用户范围、JSON-RPC 与 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);
类别准确方法名
智能体agent/create、agent/update、agent/delete、agent/applyTemplate
技能skills/list、skills/install、skills/update、skills/uninstall
模型models/list
自动化cron/list、cron/status、cron/add、cron/update、cron/remove、cron/run、cron/runs
MCP 配置mcp/list、mcp/prepare、mcp/set、mcp/unset
会话session/set_mode、session/set_model、session/clear、session/cancel
Canvascanvas/toggle、canvas/clear、canvas/reference、canvas/dimensions

第二个 TypeScript 示例沿用第一个中的 cloud 与 instanceId,使用真实的 cloud.instances.open(id) 句柄。Python 和 Go 使用各自的强类型 JSON-RPC 请求模型。这些调用对应 GET /v1/instances/{instanceId}/runtime-capabilities 和 POST /v1/instances/{instanceId}/methods,无需独立 gateway URL。宿主 Harness 适配器将方法分发到运行进程。参阅Harness SDK和模型。