Skip to content

远程访问与 API

zhenhun edited this page Sep 4, 2026 · 2 revisions

中文 | English

远程访问默认关闭,不监听任何端口;必须由用户显式开启。

开启方式

「远程」页 → 开启开关。开启后:

  • 默认监听 127.0.0.1:8600(端口可改)
  • 客户端密钥自动生成,无需手填;可另开启访问密码
  • 配置持久化在数据目录 config.json(remote_enabled / host / port / client_key / password_enabled)

鉴权

模式 凭据
仅密钥(默认) Authorization: Bearer <client_key>
密钥 + 密码 追加 X-Access-Password 头

密钥正确放行;错误凭据返回 401。

HTTP API

端点 方法 说明
/api/health GET 健康检查
/api/tools GET / POST 列出 / 注册工具
/api/tools/{id} DELETE 删除工具
/api/tools/{id}/invoke POST 手动调用工具
/api/chat POST 对话(支持 images 参数,data URL 数组)
/api/audit GET 审计日志
/api/update/check GET 检查更新
/api/update/status GET 更新下载状态
/api/update/download POST 触发下载
/mcp POST MCP Streamable HTTP 端点
/v1/models GET OpenAI 兼容模型列表
/v1/chat/completions POST OpenAI 兼容对话

把 BIT 当作 OpenAI 兼容端点

/v1/chat/completions 意味着任何支持 OpenAI 协议的客户端都能把 BIT 当作模型端点,走 BIT 的完整 Agent 能力(工具调用、记忆、技能):

curl http://127.0.0.1:8600/v1/chat/completions \
  -H "Authorization: Bearer $BIT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"bit","messages":[{"role":"user","content":"列出当前目录"}]}'

安全说明

  • 默认仅绑定 127.0.0.1,不暴露到局域网
  • 主机/端口均可修改;暴露公网请务必开启访问密码并自行做好反向代理
  • 相关 E2E 测试覆盖:默认关闭、开启监听、错误凭据 401、实例冲突处理

Clone this wiki locally