DEVELOPER DOCS

五分钟接入。

熟悉的 OpenAI 兼容 API,让你快速开始构建下一件产品。

获取 API Key

  1. 注册 Relay 账号并登录控制台。
  2. 打开「API Keys」,创建一个新的 Key。完整密钥可随点随复制,请妥善保管。
  3. 将 SDK 的 base_url 替换为 https://relayapi.app/v1,开始发送请求。

当前接口地址为 https://relayapi.app/v1。一个 Key 默认可调用全部已上线模型,无需按模型分别创建。

鉴权方式

在请求头携带你的 Key:

http
Authorization: Bearer sk-your-relay-key

可用端点:POST /v1/chat/completions(对话)、GET /v1/models(列出可用模型)。model 字段填写「模型与定价」页标注「可调用」的模型名,例如 gemini-flashgemini-pro

cURL

直接复制命令,替换 sk-your-relay-key 即可执行。

shell
curl https://relayapi.app/v1/chat/completions \
  -H "Authorization: Bearer sk-your-relay-key" \
  -H "Content-Type: application/json" \
  -d '{"model":"gemini-flash","messages":[{"role":"user","content":"Hello"}]}'

Python · openai SDK

安装 openai 后,将下面代码保存并运行。

python
from openai import OpenAI

client = OpenAI(
    api_key="sk-your-relay-key",
    base_url="https://relayapi.app/v1",
)
response = client.chat.completions.create(
    model="gemini-flash",
    messages=[{"role": "user", "content": "Hello"}],
)
print(response.choices[0].message.content)

Node.js

适用于 Node.js 18+ 与官方 OpenAI SDK。

javascript
import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "sk-your-relay-key",
  baseURL: "https://relayapi.app/v1",
});
const completion = await client.chat.completions.create({
  model: "gemini-flash",
  messages: [{ role: "user", content: "Hello" }],
});
console.log(completion.choices[0].message);

接入 Agent 客户端

任何兼容 OpenAI 接口的客户端 / Agent 都能用,只需把「API 地址 / Base URL」填为 https://relayapi.app/v1,「API Key」填你的 Relay Key,模型名填已上线模型:

  • ChatBox / NextChat / LobeChat:设置 → 模型服务 → 自定义 OpenAI,填 Base URL 与 Key。
  • Cline / Roo Code(VSCode):Provider 选 OpenAI Compatible,填 Base URL、Key、模型名。
  • Cursor / Continue:自定义 OpenAI 模型,覆盖 Base URL 与 Key。
  • 沉浸式翻译等插件:自定义 API 端点,填 Base URL 与 Key。

常见错误

  • 401:Key 错误或已删除,请到控制台确认。
  • 402 / 余额不足:余额不够,请先到「兑换充值」充值。
  • 404 / model not found:模型名拼写错误,或该模型尚未上线(见定价页「可调用」标注)。
  • 429 / 5xx:上游繁忙或暂时不可用,请稍后重试;持续失败请联系客服。

额度按 token 计费,1 元 = 1 额度,预扣 + 结算多退少补。余额与明细见控制台「Dashboard / 调用记录」。