• API 接入
  • OpenAI 兼容
  • curl
  • API Key
  • 模型调用

快速接入统一 API

通过确定基础地址、创建受限 API Key、选择已启用模型并发送最小请求,可以先验证应用与网关之间的基本连通性。

准备信息

准备部署的公开基础地址、一个仅用于该应用的 API Key,以及已在当前部署启用的模型名称。不要使用示例域名或假定某个模型在所有部署中可用。

如果应用原本使用 OpenAI 风格客户端,先确认该客户端所调用的路径和流式行为是否属于当前部署支持的兼容范围。

发送最小请求

以下示例展示常见的 Bearer 鉴权方式。将域名、Key 和模型名替换为当前部署中真实且被授权的值,再逐步加入流式、工具调用或媒体参数。

curl 'https://your-domain.example/v1/chat/completions' \
+  -H 'Authorization: Bearer sk-your-key' \
+  -H 'Content-Type: application/json' \
+  -d '{"model":"your-enabled-model","messages":[{"role":"user","content":"Hello"}]}'

从验证走向生产

将基础地址和 Key 放入服务端环境变量或受管理的密钥存储。为每个环境使用不同 Key,记录模型与超时策略,并针对失败响应、限额耗尽和上游不可用建立降级行为。

项目来源:README.zh_CN.md、router/relay-router.go、docs/api/

相关页面