文档服务端 SDK

BEEOS CLOUD / DEVELOPER REFERENCE

服务端资源方法

使用强类型 Cloud 资源方法及其 HTTP 契约

服务端 SDK 2.0.0 通过 BeeOSClient(TypeScript/Python)和 NewBeeOSClient(Go)提供强类型资源方法和结果。传入强类型请求对象,客户端自动处理认证、用户范围和变更请求头。

TypeScript 方法HTTP 路由用途
catalog.getDiscovery()GET /uhp/v1/uhp查询协议能力
instances.create(input, key)POST /v1/instances创建托管实例,按需携带 BYOK llm
responses.create(input, key)POST /uhp/v1/responses向就绪 harness 发送输入
responses.get(id)GET /uhp/v1/responses/{response_id}查询状态与输出
responses.getInputItems(id)GET /uhp/v1/responses/{response_id}/input_items查询输入历史

资源流程

用 cloud.catalog.listInstanceTemplates() 选择已发布的 variant_id。创建返回 202;通过 cloud.instances.getStatus(created.data.id) 查询就绪状态,再用 cloud.harnesses.list() 选择就绪 harness。Python 对应 list_instance_templates 和 get_status;Go 对应 Catalog.ListInstanceTemplates、Instances.GetStatus 和 Harnesses.List。

产品用户请求传 X-BeeOS-External-User-ID,每次变更使用稳定的 Idempotency-Key。SDK 将非成功 HTTP 响应作为 API 错误抛出。Responses 通过 metadata.harness_id 选择 harness;保存 Response ID,下一回合传 previous_response_id。参阅快速开始、运行时方法和安全。