客户端与 API 接入
使用 cURL、Python、Node.js 或兼容客户端连接 BOS API。
地址、认证与协议
OpenAI SDK 的 Base URL 使用带 /v1 的网关地址,认证使用 Authorization: Bearer BOS_API_KEY。下方示例调用 /v1/chat/completions;模型必须由管理员配置并授权给当前 Key。
| 客户端或协议 | 地址或接口 | 认证方式 |
|---|---|---|
| OpenAI SDK | <GATEWAY_URL>/v1 | Bearer 网关 Key |
| Chat Completions | POST /v1/chat/completions | Authorization 请求头 |
| 第三方兼容客户端 | OpenAI-compatible Base URL | API Key 配置项 |
选择你的客户端
四个标签使用相同的地址、Key 和模型。先设置 BOS_GATEWAY_KEY 环境变量,再替换示例地址和模型 ID。
curl --fail-with-body "https://bosapi.example.com/v1/chat/completions" \
-H "Authorization: Bearer $BOS_GATEWAY_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "YOUR_MODEL_ID",
"messages": [
{"role": "user", "content": "Say hello in one sentence."}
]
}'# Install: python -m pip install openai
import os
from openai import OpenAI
client = OpenAI(
api_key=os.environ["BOS_GATEWAY_KEY"],
base_url="https://bosapi.example.com/v1",
)
response = client.chat.completions.create(
model="YOUR_MODEL_ID",
messages=[
{"role": "user", "content": "Say hello in one sentence."}
],
)
print(response.choices[0].message.content)// Install: npm install openai
import OpenAI from "openai";
const client = new OpenAI({
apiKey: process.env.BOS_GATEWAY_KEY,
baseURL: "https://bosapi.example.com/v1",
});
const response = await client.chat.completions.create({
model: "YOUR_MODEL_ID",
messages: [
{ role: "user", content: "Say hello in one sentence." }
],
});
console.log(response.choices[0].message.content);Base URL https://bosapi.example.com/v1
API Key YOUR_BOS_API_KEY
Model YOUR_MODEL_ID
Protocol OpenAI-compatible / Chat CompletionsResponses 与 Anthropic Messages
BOS API 还提供 /v1/responses 与 /v1/messages 等协议入口,但可用性取决于模型、渠道格式和当前 Key 权限。支持 Chat Completions 不代表自动支持 Responses 或 Messages。
- 使用 Codex 前,确认模型支持 Responses。
- 使用 Anthropic SDK 时,Base URL 通常使用不带 /v1 的网关根地址,由 SDK 追加 /v1/messages。
- 流式输出和工具调用需要单独验证客户端行为。
Messages 转 Chat 的思考参数
Messages 转 Chat 时,调用方提供的 thinking、reasoning_effort 和 enable_thinking 原样转发,包含 null 与 thinking 内的厂商自定义字段。BOS 不补默认值或校验这些字段的类型、模式和预算范围;上游决定是否接受,拒绝时按上游错误处理。output_config.effort 仍是本地消费的兼容提示,不映射为思考控制。
凭证与排错边界
网关 Key、后台登录令牌、Key 门户会话和上游 Provider Key 是不同凭证。不要把真实 Key 放进 URL、前端构建产物、截图或共享日志。
按部署版本核对具体能力与操作。 查看文档适用范围