5 分钟完成第一次调用

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

开发者快速开始更新于 2026-10-21

从管理员获取三项信息

调用前,管理员需要已经接入可用的上游服务、配置模型权限,并为当前应用签发 BOS API 网关 Key。

  • API Base URL:通常形如 https://bosapi.example.com/v1。
  • BOS API Key:只用于网关调用,不是后台登录令牌或上游 Provider Key。
  • 模型 ID:管理员确认已授权且支持 Chat Completions 的模型标识。

步骤一:设置本地环境变量

将示例值替换为管理员提供的信息。只在自己的终端或密钥管理工具中设置真实 Key,不要提交到代码仓库,也不要启用 shell 命令跟踪。

macOS、Linux 或 WSL
export BOS_GATEWAY_KEY="YOUR_BOS_API_KEY"
export BOS_BASE_URL="https://bosapi.example.com/v1"
export BOS_MODEL="YOUR_MODEL_ID"

步骤二:确认 Key 可以看到模型

先请求模型列表,确认地址、鉴权和模型授权均有效。成功时返回 HTTP 200;从响应中确认要使用的模型 ID。

查询已授权模型
curl --fail-with-body --silent --show-error   "$BOS_BASE_URL/models"   -H "Authorization: Bearer $BOS_GATEWAY_KEY"

步骤三:完成第一次模型调用

以下请求使用 OpenAI Chat Completions 兼容接口。成功时返回 HTTP 200 和 choices 数组,可从 choices[0].message.content 读取文本回复。

第一次 Chat Completions 调用
curl --fail-with-body --silent --show-error   "$BOS_BASE_URL/chat/completions"   -H "Authorization: Bearer $BOS_GATEWAY_KEY"   -H "Content-Type: application/json"   -d '{
    "model": "'"$BOS_MODEL"'",
    "messages": [{"role": "user", "content": "Say hello in one sentence."}]
  }'

步骤四:核对记录并继续接入

保留响应中的 X-Request-ID,并在调用记录中核对模型、状态、耗时和用量。若失败,依次检查 Base URL 是否包含 /v1、Key 是否有效、模型是否授权,以及上游渠道是否可用。

按部署版本核对具体能力与操作。 查看文档适用范围

BOS API · TYPEX

销售咨询暂不可用

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

查看文档免费自托管