QUICKSTART

五分钟接入 Relay

Relay 完全兼容 OpenAI Chat Completions API。修改 Base URL 和 API Key,即可开始调用。

1

创建 API Key

进入控制台的 API Key 页面,点击「创建新 Key」。完整 Key 只展示一次,请妥善保存。

sk-relay-v1_xxxxxxxxxxxxxxxxxxxxxxxx
2

发起第一次请求

选择你习惯的调用方式。开发环境默认提供 relay-mini mock 模型,不配置上游也能跑通。

curl http://localhost:8080/v1/chat/completions \
  -H "Authorization: Bearer sk-relay-your-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "relay-mini",
    "messages": [
      { "role": "user", "content": "Hello, Relay!" }
    ],
    "stream": true
  }'
3

处理响应

非流式响应与 OpenAI 格式一致,并额外通过响应头返回 Relay 请求 ID,方便定位调用日志。

{
  "id": "chatcmpl_01J...",
  "model": "relay-mini",
  "usage": { "prompt_tokens": 12, "completion_tokens": 24 }
}

身份认证

所有模型请求都需要在 Authorization 请求头中携带 Bearer Token。Relay 只保存 API Key 的 SHA-256 哈希。

流式响应

设置 stream: true 即可获得标准 SSE 数据流。计费会在流结束后自动完成。

接入遇到问题?联系我们