Catalog

Overview

The catalog domain lists what you can choose from when you create resources: providers, deploy regions and models, instance templates, and agent templates. It also serves the protocol discovery document, which needs no authentication.

8 operations · SDK resource: TypeScript cloud.catalog · Python cloud.catalog · Go cloud.Catalog · API overview

Operations whose path starts with /uhp/v1 are served from https://api.cloud.beeos.ai/uhp/v1 instead of https://api.cloud.beeos.ai/v1; the SDKs switch automatically.

Main objects

• InstanceTemplate (with its CatalogVariant entries): a template whose published variant you pick when you create an instance.
• Provider, DeployRegion, and DeployModel: where and with what models instances can run.
• agentTemplateCatalogView: an agent template.
• UHPDiscovery: the protocol discovery document.

InstanceTemplate

Every field, and the methods that use this object: appendix.

CatalogVariant

Every field, and the methods that use this object: appendix.

Provider

Every field, and the methods that use this object: appendix.

DeployRegion

Every field, and the methods that use this object: appendix.

DeployModel

Every field, and the methods that use this object: appendix.

agentTemplateCatalogView

Every field, and the methods that use this object: appendix.

UHPDiscovery

Every field, and the methods that use this object: appendix.

CatalogSpec

Every field, and the methods that use this object: appendix.

ProviderCapabilities

Every field, and the methods that use this object: appendix.

UHPCapabilities

Named booleans. A server reports false for a capability it does not implement rather than omitting it, so a client can distinguish "not supported" from "server predates this field". A client treats an absent key as false.

Every field, and the methods that use this object: appendix.

Typical flow

1. List the templates with catalog.listInstanceTemplates and read one with catalog.getInstanceTemplate to choose a variant.
2. Check the choices for placement and models with catalog.listProviders, catalog.listRegions, and catalog.listModels.
3. Create the instance with instances.create.
4. catalog.listAgentTemplates and catalog.getAgentTemplate list the agent templates; catalog.getDiscovery tells a client which protocol versions the server speaks.

Methods

catalog.listAgentTemplates

GET /v1/agent-templates · Operation ID listAgentTemplates

List agent templates

SDK methods

Parameters

Response

200 · application/json

Errors

The error schemas are described in Errors.

Example

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

Get an agent template

SDK methods

Parameters

Response

200 · application/json · Schema: agentTemplateCatalogView

Errors

The error schemas are described in Errors.

Example

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

List deploy models

SDK methods

Parameters

Response

200 Deploy models · application/json · Schema: ModelPage

Errors

The error schemas are described in Errors.

Example

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

List deploy regions

SDK methods

Parameters

Response

200 Deploy regions · application/json · Schema: RegionPage

Errors

The error schemas are described in Errors.

Example

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

List instance templates

SDK methods

Parameters

Response

200 Instance templates · application/json · Schema: InstanceTemplatePage

Errors

The error schemas are described in Errors.

Example

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

Get an instance template

SDK methods

Parameters

Response

200 Instance template · application/json · Schema: InstanceTemplate

Errors

The error schemas are described in Errors.

Example

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

List providers

SDK methods

Parameters

Response

200 Provider catalog · application/json · Schema: ProviderPage

Errors

The error schemas are described in Errors.

Example

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

Protocol discovery document

Served without authentication: a client must be able to learn whether it is talking to a UHP server, and which versions it speaks, before presenting credentials. The document contains nothing principal-specific.

No authentication required.

SDK methods

Response

200 The discovery document · application/json · Schema: UHPDiscovery

Errors

The error schemas are described in Errors.

Example

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);