This reference is currently available in English. The Cloud console remains in your selected language.
BEEOS CLOUD / DEVELOPER REFERENCE
Server resource methods
Use typed Cloud resource methods and their HTTP contracts
Server SDK 2.0.0 exposes typed resource methods and results through BeeOSClient (TypeScript/Python) and NewBeeOSClient (Go). Pass typed request objects; the client supplies authentication, user scope, and mutation headers.
| TypeScript method | HTTP route | Purpose |
|---|---|---|
catalog.getDiscovery() | GET /uhp/v1/uhp | Discover protocol capabilities |
instances.create(input, key) | POST /v1/instances | Create a managed instance with BYOK llm when required |
responses.create(input, key) | POST /uhp/v1/responses | Send input to a ready harness |
responses.get(id) | GET /uhp/v1/responses/{response_id} | Read status and output |
responses.getInputItems(id) | GET /uhp/v1/responses/{response_id}/input_items | Read the input history |
Resource flow
Use cloud.catalog.listInstanceTemplates() to select a published variant_id. Creation returns 202; read cloud.instances.getStatus(created.data.id) for readiness and cloud.harnesses.list() to choose a ready harness. Python uses list_instance_templates and get_status; Go uses Catalog.ListInstanceTemplates, Instances.GetStatus, and Harnesses.List.
Send X-BeeOS-External-User-ID for product-user work and a stable Idempotency-Key for each mutation. The SDK raises API errors for non-success HTTP responses. For Responses, select metadata.harness_id, retain the Response ID, and pass previous_response_id for the next turn. See quickstart, runtime methods, and security.