API 文档

RelayAI 提供 OpenAI / Anthropic 兼容接口，并统一处理鉴权、模型路由、限速、计费和用量记录。

快速接入指南

如果你已经在使用 OpenAI SDK，通常只需修改 Base URL 和 API Key 即可切换到 RelayAI：

Python

from openai import OpenAI

client = OpenAI(
    api_key="rk-xxxxxxxxxxxx",              # RelayAI API Key
    base_url="https://relayai.aolingtech.com/api/v1"
)

response = client.chat.completions.create(
    model="glm-5.2",
    messages=[
        {"role": "user", "content": "Hello, RelayAI!"}
    ]
)

print(response.choices[0].message.content)

cURL

curl https://relayai.aolingtech.com/api/v1/chat/completions \
  -H "Authorization: Bearer rk-xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "glm-5.2",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

认证方式

所有 API 请求必须携带 API Key。OpenAI 兼容端点推荐使用 Authorization Header，Anthropic 兼容端点也支持 x-api-key。

Authorization: Bearer rk-xxxxxxxxxxxx
x-api-key: rk-xxxxxxxxxxxx

API Key 可在控制台的「密钥管理」页面创建。一个 Key 同时配置模型权限、路由策略、RPM 和可选月度预算。

• 全部常规模型只包含不按量采购的 standard 模型。
• 按量模型必须在同一个 API Key 中逐个显式授权。
• 未来新增按量模型不会自动授权给已有 Key。
• 创建结果显示一次完整明文；之后只能直接复制，不在页面重新显示。

路由策略

路由策略绑定在 API Key 上。客户端请求仍只传模型 ID，不能通过 Header 或请求体覆盖该 Key 的路由策略。

上游厂商政策限流不由路由策略本身解决；例如智谱 1305 仍需要标准 API 池或上游授权确认。

Chat Completions

Responses（Codex）

{
  "model": "deepseek-v4-flash",
  "instructions": "You are a coding assistant.",
  "input": "Explain this error in one sentence.",
  "stream": true
}

model_provider = "relayai"
model = "deepseek-v4-flash"

[model_providers.relayai]
name = "RelayAI"
base_url = "https://relayai.aolingtech.com/api/v1"
wire_api = "responses"
requires_openai_auth = true
env_key = "RELAYAI_API_KEY"

Messages

{
  "model": "glm-5.2",
  "max_tokens": 1000,
  "messages": [
    { "role": "user", "content": "Hello" }
  ],
  "stream": true
}

Models

当前支持的模型：

返回结果示例：

{
  "object": "list",
  "data": [
    { "id": "deepseek-v4-flash", "object": "model", "owned_by": "deepseek" },
    { "id": "glm-5.2", "object": "model", "owned_by": "zhipu" },
    { "id": "kimi-k2.6", "object": "model", "owned_by": "volcengine" }
  ]
}

Embeddings

速率限制

速率限制按 API Key 配置。超出限制时返回 HTTP 429。

错误码

• 模型可用但当前 Key 未显式授权时返回 403，error.code=model_forbidden。
• Chat Completions 的 404/503 使用 OpenAI 错误对象，分别通过error.code=model_not_found和error.code=model_temporarily_unavailable标识。
• Responses 的 404/503 同样使用 OpenAI 错误对象和上述error.code；对应error.type分别为invalid_request_error和model_unavailable。
• Messages 使用 Anthropic 错误信封且没有独立error.code：404 为error.type=not_found_error；503 为error.type=api_error，并在 message 中携带model_temporarily_unavailable。

旧模型名兼容

以下标识仅用于历史 API Key 白名单归一化，不能作为请求 model 直接调用。客户端必须使用当前模型名。

从 OpenAI API 迁移

如果你已经在使用 OpenAI 官方 SDK 或直接调用 API，只需以下三步即可完成迁移。

1. 替换 Base URL

将请求地址从 OpenAI 官方域名改为 RelayAI：

- base_url = "https://api.openai.com/v1"
+ base_url = "https://relayai.aolingtech.com/api/v1"

2. 认证方式不变

RelayAI 的 API Key 格式为 rk-...，但 Authorization Header 的格式与 OpenAI 完全一致，无需修改认证逻辑：

Authorization: Bearer rk-xxxxxxxxxxxx

3. 兼容性差异

大部分功能可直接使用，少数功能存在差异：

• Streaming（流式输出） — 完全兼容，无需改动
• Function Calling（函数调用） — 已支持，参数格式与 OpenAI 一致
• Responses（Codex） — 已支持首版 Codex 文本和工具调用流程
• Embeddings — 尚未实现，当前返回 HTTP 501

兼容性矩阵

各模型在 RelayAI 中转层上的功能支持情况：

PPToken 和 Moonshot 已实现但默认关闭/受限；满足服务端开关、模型白名单、凭证和价格配置后可启用，并仍需 API Key 显式授权。