BOS API 文档
快速查阅与配置指南

从第一次调用模型,到权限配置、安全规则和自托管部署,都在这里。

第一次使用

拿到地址和 Key,5 分钟发出第一次请求。

打开快速开始
按角色阅读

按你的角色开始

开发接入、日常管理或运维部署,挑选适合你职责的章节。

全部指南

按任务浏览完整目录

搜索会同时匹配标题、摘要和章节名称。

快速开始

从管理员获取地址、Key 和模型,验证模型列表并完成第一次 Chat Completions 调用。

阅读指南

客户端接入

使用 cURL、Python、Node.js 或兼容客户端连接 BOS API。

阅读指南

编程工具接入

将 Codex、Claude Code 和兼容客户端连接到授权模型,并核对调用记录。

阅读指南

模型与渠道

分清服务提供方、渠道、模型与应用调用入口。

阅读指南

组织与 Key

围绕使用者和应用分配 Key,理解资源与访问的边界。

阅读指南

管理员初始化

从首次登录开始,完成渠道、模型、权限和网关 Key 的最小可用配置。

阅读指南

后台日常管理

按步骤管理组织、渠道、Key、路由、用量和安全配置。

阅读指南

官方订阅账号

通过 OAuth 连接 ChatGPT / Codex、Claude、Gemini CLI / Code Assist 和 Antigravity,配置模型并交付网关调用。

阅读指南

安全治理

理解输入凭证、提示注入特征、输出代码标记与事件追查,核对命中与实际处置。

阅读指南

用量与额度

分清 Token、成本、累计额度与调用频率的含义。

阅读指南

调用与排错

从请求标识开始,逐步核对配置、授权、额度和上游响应。

阅读指南

一键安装

在 Linux 或 macOS 上一键部署 BOS API。已有源码可直接启动,无需 Nginx,并可选择 IP 加端口访问。

阅读指南

Docker Compose 部署

从源码构建 BOS API,手动管理私有配置、应用、MySQL 与 Redis,完成 HTTPS 和日常运维。

阅读指南

本地开发部署

在本机运行 Go 后端和 Vite 前端,使用独立的 MySQL、Redis 开发依赖,完成登录、调试与构建验证。

阅读指南

主机监控

在 Linux 主机安装可选采集器,验证数据新鲜度并排查状态页。

阅读指南

镜像与后台更新

发布已提交的镜像,安装更新器,检查更新并按数据库兼容性恢复。

阅读指南

升级与备份

围绕配置、数据库、Redis 和网关数据准备可恢复的升级流程。

阅读指南

部署排错

从 Docker、Compose、容器健康、反向代理和业务调用逐层定位问题。

阅读指南

版本与限制

核对文档、部署版本与验证结果是否对应。

阅读指南

示例使用占位地址、Key 和模型。具体能力仍需与实际部署版本核对。

了解适用范围
BOS API · TYPEX

销售咨询暂不可用

暂时无法初始化销售接待,请稍后重试。你仍可查看文档并免费自托管。

查看文档免费自托管