Skip to main content
本页给出一条最短可跑通的调用链路:先验证 API Key,再发出第一条模型请求。示例使用标准 OpenAI 兼容入口,适合新接入项目、后端服务和命令行调试。 开始前需要准备: 如果还不确定 API Key 应该放在哪个请求头里,先看 认证。

1. 设置环境变量

建议先把域名和 API Key 放进环境变量,后续示例可以直接复用。
Windows PowerShell 可以使用:

2. 查询模型列表

第一步先调用 GET /v1/models。这一步不产生模型推理内容,适合用来确认 API Key、账号状态和可用模型。
如果请求成功,响应中会返回当前账号可访问的模型列表。后续请求中的 model 字段应该从这里选择。 也可以查询单个模型:
这一步失败时,通常先排查:

3. 发送第一条聊天请求

推荐把 POST /v1/chat/completions 作为第一条推理请求。它使用 OpenAI Chat Completions 风格,字段简单,适合快速验证接入是否成功。
请求体字段说明: 成功响应通常会包含 choices,模型回复位于 choices[0].message.content。
示例响应只展示关键字段。真实响应还可能包含 id、object、created、model、usage 等字段,具体以接口实际返回为准。

4. 启用流式输出

如果希望边生成边接收结果,把 stream 设置为 true。
流式响应适合聊天界面、长文本生成和需要尽快展示首字的场景。客户端需要按 Server-Sent Events 或兼容流式格式逐段读取内容。

5. Responses 示例

如果客户端已经使用 OpenAI Responses 风格,可以调用 POST /v1/responses。
项目也提供了压缩上下文入口:
不同模型是否支持 Responses 或压缩入口,取决于后端可用渠道配置。若返回模型或渠道不可用,请换用 GET /v1/models 中可见的模型。

6. 兼容格式示例

如果已有 Claude 或 Gemini 的现成 SDK,可以用兼容入口做首测。 Claude Messages 示例:
Gemini 模型列表示例:
也可以使用查询参数形式:
兼容入口的认证头和返回格式可能与标准 /v1/* 接口不同。详细说明见 兼容格式。

7. 常见报错

参考资料