AgentbaseDocs
文档目录

运行环境(endpoint 与 region)

SDK 接入前必须先确定两个环境事实:API endpoint(SDK 调用的绝对基址)与 region(项目部署区域,2.6.0 只有 default)。本页同时说明托管环境与自托管实例的差异,以及 Sites 访问地址的推导规则。

Endpoint 规范

环境API endpoint(SDK setEndpoint)Console origin
托管测试(SIT)https://appbuild-sit.oceanbase.com/v1https://appbuild-sit.oceanbase.com
托管正式https://appbuild.oceanbase.com/v1https://appbuild.oceanbase.com
自托管https://<你的实例域名或IP>:<port>/v1同实例去掉 /v1 的 origin

不确定当前环境时:登录对应 Console,在浏览器开发者工具 → Network 中找任意 /v1/... 请求,复制它的 origin + /v1。Agentbase 不使用 Appwrite Cloud 的区域端点(*.cloud.appwrite.io),也禁止静默回退到另一个环境。

Region

托管环境差异

自托管差异

环境上下文文件(可选约定)

需要把环境元数据交给自动化(Agent / 部署脚本)时,可保存非敏感上下文(endpoint、region、来源),禁止写入邮箱、密码、Session、API Key、Project ID 等凭据:

{
  "schemaVersion": 1,
  "apiEndpoint": "https://appbuild.oceanbase.com/v1",
  "consoleOrigin": "https://appbuild.oceanbase.com",
  "region": "default",
  "source": "console-skill-card"
}

存放位置:用户级 ${XDG_CONFIG_HOME:-$HOME/.config}/ob-agentbase/environment.json;项目级 <projectRoot>/.agentbase/environment.json 覆盖用户级。解析顺序:请求显式给定 → 项目级 → 项目 .env 的 APPBASE_ENDPOINT(兼容 APPWRITE_ENDPOINT)→ 用户级 → 询问用户。

事实源