目录

概览

catalog domain 列出创建资源时可供选择的内容：provider、部署区域与模型、实例模板和智能体模板。它还提供协议 discovery 文档，该文档无需鉴权。

8 个操作 · SDK 资源：TypeScript cloud.catalog · Python cloud.catalog · Go cloud.Catalog · API 总览

路径以 /uhp/v1 开头的操作由 https://api.cloud.beeos.ai/uhp/v1 提供，而不是 https://api.cloud.beeos.ai/v1；SDK 会自动切换。

主要对象

• InstanceTemplate（及其 CatalogVariant 条目）：创建实例时从中选择已发布 variant 的模板。
• Provider、DeployRegion、DeployModel：实例可以在哪里、用哪些模型运行。
• agentTemplateCatalogView：智能体模板。
• UHPDiscovery：协议 discovery 文档。

InstanceTemplate

完整字段和使用该对象的方法见附录。

CatalogVariant

完整字段和使用该对象的方法见附录。

Provider

完整字段和使用该对象的方法见附录。

DeployRegion

完整字段和使用该对象的方法见附录。

DeployModel

完整字段和使用该对象的方法见附录。

agentTemplateCatalogView

完整字段和使用该对象的方法见附录。

UHPDiscovery

完整字段和使用该对象的方法见附录。

CatalogSpec

完整字段和使用该对象的方法见附录。

ProviderCapabilities

完整字段和使用该对象的方法见附录。

UHPCapabilities

具名布尔值。服务器对自己没有实现的能力报告 false，而不是省略它，这样客户端就能区分“不支持”和“服务器早于该字段”。客户端把缺失的键视为 false。

完整字段和使用该对象的方法见附录。

典型流程

1. 用 catalog.listInstanceTemplates 列出模板，用 catalog.getInstanceTemplate 读取其中一个，选定 variant。
2. 用 catalog.listProviders、catalog.listRegions、catalog.listModels 查看可选的部署位置与模型。
3. 用 instances.create 创建实例。
4. catalog.listAgentTemplates 与 catalog.getAgentTemplate 列出智能体模板；catalog.getDiscovery 告诉客户端服务端支持哪些协议版本。

方法

catalog.listAgentTemplates

GET /v1/agent-templates · Operation ID listAgentTemplates

列出 agent 模板

SDK 方法

参数

响应

200 · application/json

错误

错误 schema 见错误。

示例

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

const cloud = new BeeOSClient({
  baseURL: "https://api.cloud.beeos.ai/v1",
  apiKey: "YOUR_API_KEY", // bsk_ key: backend only
});
const result = await cloud.catalog.listAgentTemplates();
console.log(result);

catalog.getAgentTemplate

GET /v1/agent-templates/{id} · Operation ID getAgentTemplate

获取 agent 模板

SDK 方法

参数

响应

200 · application/json · Schema: agentTemplateCatalogView

错误

错误 schema 见错误。

示例

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

const cloud = new BeeOSClient({
  baseURL: "https://api.cloud.beeos.ai/v1",
  apiKey: "YOUR_API_KEY", // bsk_ key: backend only
});
const result = await cloud.catalog.getAgentTemplate("id_123");
console.log(result);

catalog.listModels

GET /v1/deploy/models · Operation ID listDeployModels

列出部署模型

SDK 方法

参数

响应

200 部署模型 · application/json · Schema: ModelPage

错误

错误 schema 见错误。

示例

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

const cloud = new BeeOSClient({
  baseURL: "https://api.cloud.beeos.ai/v1",
  apiKey: "YOUR_API_KEY", // bsk_ key: backend only
});
const result = await cloud.catalog.listModels();
console.log(result);

catalog.listRegions

GET /v1/deploy/regions · Operation ID listDeployRegions

列出部署区域

SDK 方法

参数

响应

200 部署区域 · application/json · Schema: RegionPage

错误

错误 schema 见错误。

示例

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

const cloud = new BeeOSClient({
  baseURL: "https://api.cloud.beeos.ai/v1",
  apiKey: "YOUR_API_KEY", // bsk_ key: backend only
});
const result = await cloud.catalog.listRegions();
console.log(result);

catalog.listInstanceTemplates

GET /v1/instance-templates · Operation ID listInstanceTemplates

列出实例模板

SDK 方法

参数

响应

200 实例模板 · application/json · Schema: InstanceTemplatePage

错误

错误 schema 见错误。

示例

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

const cloud = new BeeOSClient({
  baseURL: "https://api.cloud.beeos.ai/v1",
  apiKey: "YOUR_API_KEY", // bsk_ key: backend only
});
const result = await cloud.catalog.listInstanceTemplates();
console.log(result);

catalog.getInstanceTemplate

GET /v1/instance-templates/{templateId} · Operation ID getInstanceTemplate

获取实例模板

SDK 方法

参数

响应

200 实例模板 · application/json · Schema: InstanceTemplate

错误

错误 schema 见错误。

示例

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

const cloud = new BeeOSClient({
  baseURL: "https://api.cloud.beeos.ai/v1",
  apiKey: "YOUR_API_KEY", // bsk_ key: backend only
});
const result = await cloud.catalog.getInstanceTemplate("template_123");
console.log(result);

catalog.listProviders

GET /v1/providers · Operation ID listProviders

列出 provider

SDK 方法

参数

响应

200 Provider 目录 · application/json · Schema: ProviderPage

错误

错误 schema 见错误。

示例

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

const cloud = new BeeOSClient({
  baseURL: "https://api.cloud.beeos.ai/v1",
  apiKey: "YOUR_API_KEY", // bsk_ key: backend only
});
const result = await cloud.catalog.listProviders();
console.log(result);

catalog.getDiscovery

GET /uhp/v1/uhp · Operation ID getDiscovery

协议发现文档

无需认证即可访问：客户端必须能在出示凭证之前了解自己所连接的是否是 UHP 服务器，以及它支持哪些版本。该文档不包含任何与主体相关的内容。

无需鉴权。

SDK 方法

响应

200 发现文档 · application/json · Schema: UHPDiscovery

错误

错误 schema 见错误。

示例

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

const cloud = new BeeOSClient({
  baseURL: "https://api.cloud.beeos.ai/v1",
  apiKey: "YOUR_API_KEY", // bsk_ key: backend only
});
const result = await cloud.catalog.getDiscovery();
console.log(result);