OpenAI 兼容接口
ZBStream 提供 OpenAI 兼容的 Chat Completions 接口。任何支持自定义 Base URL 的 OpenAI SDK 或 HTTP 客户端都可以直接使用,支持 cURL、Python、Node.js 和 Go。
接入信息
所有 OpenAI 兼容请求都发往同一个基础地址,使用 Bearer API Key 鉴权。模型名称必须与 GET /v1/models 返回的 id 完全一致。
Authorization: Bearer $ZBSTREAM_API_KEY
Content-Type: application/json| 参数 | 值 | 说明 |
|---|---|---|
| Base URL | https://api.zbstream.com/v1 | 所有 OpenAI 兼容请求的基础地址 |
| 鉴权 | Authorization: Bearer <key> | 使用控制台创建的 ZBStream API Key |
| 模型查询 | GET /v1/models | 列出当前 API Key 可用的模型 |
发起对话补全
下面是同一个非流式对话请求在四种语言中的写法。响应结构与 OpenAI Chat Completions 一致,可直接读取 choices[0].message.content。
curl https://api.zbstream.com/v1/chat/completions \
-H "Authorization: Bearer $ZBSTREAM_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "deepseek-v4-pro",
"messages": [
{ "role": "user", "content": "你好,请介绍一下 ZBStream API。" }
],
"stream": false
}'
流式输出
在请求体中加入 "stream": true 即可获得 SSE 流式响应。客户端应按事件顺序读取 data 行,并在收到 [DONE] 标记后关闭连接。
curl https://api.zbstream.com/v1/chat/completions \
-H "Authorization: Bearer $ZBSTREAM_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "deepseek-v4-pro",
"messages": [{ "role": "user", "content": "请逐步回答" }],
"stream": true
}'
查询可用模型
调用 GET /v1/models 获取当前 API Key 可用的模型列表。建议客户端动态读取而不是写死模型 id。
curl https://api.zbstream.com/v1/models \
-H "Authorization: Bearer $ZBSTREAM_API_KEY"兼容性说明
- 官方 openai-python、openai-node 等 SDK 均可通过设置 base_url 直接使用。
- temperature、top_p 等采样参数会随请求转发,支持范围由所选模型决定。
- 模型映射时仅替换 model 字段,其余字段原样转发到上游渠道。
- 未在文档中列出的字段不构成平台兼容性承诺,能力以当前模型与渠道配置为准。