DocsServer SDK

BEEOS CLOUD / DEVELOPER REFERENCE

Cloud Server SDK

Manage Cloud resources from a trusted product backend

Use Cloud Server SDK 2.0.0 with a bsk_ server key from a trusted backend. Set BEEOS_CLOUD_API_URL to your environment’s /v1 URL. TypeScript @beeos-ai/cloud-sdk, Python distribution beeos-cloud-sdk (import beeos_cloud_sdk), and Go github.com/beeos-ai/beeos-cloud-sdks/go/v2 come from the beeos-cloud-sdks repository. See language setup.

Python: pip install beeos-cloud-sdk==2.0.0.

import { BeeOSClient } from "@beeos-ai/cloud-sdk";

const cloud = new BeeOSClient({
  baseURL: process.env.BEEOS_CLOUD_API_URL!, // https://api.cloud.beeos.ai/v1
  apiKey: process.env.BEEOS_API_KEY!, // bsk_…, backend only
}).withExternalUser(process.env.BEEOS_EXTERNAL_USER_ID!);

const discovery = await cloud.catalog.getDiscovery();
console.log(discovery);

Typed resource methods

BeeOSClient exposes catalog, instances, harnesses, and responses with typed inputs and results. Use withExternalUser(id) (Python: with_external_user, Go: WithExternalUser) for product-user work. Pass a stable idempotency key for each mutation; the SDK sets the headers and raises an API error on non-success responses.

instances.create accepts variant_id and BYOK llm.providers / llm.models. Model-free AgentBay and BeeOS browser/mobile variants omit llm. The typed creation result contains data.id and operation; Responses have their own id, status, and output. See the quickstart.

The SDK routes harnesses, Responses, and discovery to /uhp/v1 on the same host; ordinary Server resources use /v1. For versioned writes, pass the resource version. See resource methods, runtime methods, and language setup.