兼容 OpenAI 的 API

Base URL 与认证

在 OpenAI SDK 和 OpenAI 风格的应用中使用以下 Base URL：

https://bsxinai.com/v1

以 Bearer Token 形式发送密钥：

Authorization: Bearer $BSXIN_API_KEY

端点

方法	路径	用途
`GET`	`/v1/models`	列出该密钥可以调用的模型
`POST`	`/v1/chat/completions`	Chat Completions，支持流式和非流式
`POST`	`/v1/responses`	Responses API，支持流式和非流式
`POST`	`/v1/responses/compact`	压缩 Responses 对话
`POST`	`/v1/completions`	旧版文本补全
`POST`	`/v1/embeddings`	向量嵌入
`POST`	`/v1/images/generations`	图片生成
`POST`	`/v1/images/edits`	图片编辑（`multipart/form-data`）

GET /v1/responses 还接受 WebSocket 升级，供使用 Responses WebSocket 传输的客户端使用。只使用 GET /v1/models 为你的密钥列出的模型。

Chat Completions

curl https://bsxinai.com/v1/chat/completions \
  -H "Authorization: Bearer $BSXIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "YOUR_MODEL_ID",
    "messages": [{ "role": "user", "content": "Hello" }],
    "stream": true
  }'

设置 "stream": true 可接收服务器发送事件（SSE）。省略该字段则返回一个完整的 JSON 响应。

Responses

curl https://bsxinai.com/v1/responses \
  -H "Authorization: Bearer $BSXIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "YOUR_MODEL_ID",
    "input": "Hello"
  }'

使用 OpenAI SDK

import os
from openai import OpenAI

client = OpenAI(
    base_url="https://bsxinai.com/v1",
    api_key=os.environ["BSXIN_API_KEY"],
)

reply = client.chat.completions.create(
    model="YOUR_MODEL_ID",
    messages=[{"role": "user", "content": "Hello"}],
)
print(reply.choices[0].message.content)

以 OpenAI 格式调用 Claude 模型

BSXin AI 会在不同 API 格式之间转换。Claude 分组的密钥可以在 /v1/chat/completions 上调用 Claude 模型。回复使用 OpenAI 格式。文本、工具调用、推理和用量的含义保持不变。

使用此格式的应用

Codex：使用 ~/.codex/config.toml。详见配置助手。
OpenCode：使用基于 @ai-sdk/openai-compatible 的自定义 provider。详见配置助手。
CC Switch 的 Codex 标签页：详见 CC Switch。

错误格式

错误响应包含 HTTP 状态码和 JSON 响应体。从 error.code 读取错误原因，从 error.message 读取详细信息。各错误码的说明请参阅故障排查。

兼容 OpenAI 的 API

本页目录