接入文档

快速开始

RelayAI 提供与 OpenAI 完全兼容的 API。已有 OpenAI SDK 代码无需重写,仅替换 base_urlapi_key 即可接入国内外全部模型。

API 密钥在企业资质审核通过后,于 控制台 → API 密钥 创建。密钥等同于账户凭证,请妥善保管,切勿提交到代码仓库或前端。

鉴权

所有请求通过 HTTP 请求头中的 Bearer Token 鉴权。Base URL 如下:

BASEhttps://api.relayai.com.cn/v1

在请求头中携带密钥:

Authorization: Bearer sk-relay-xxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

发起第一个请求

调用 /chat/completions 接口发起一次对话补全。下面的示例以国产模型 deepseek-v4 为例:

POST/v1/chat/completions
# cURL
curl https://api.relayai.com.cn/v1/chat/completions \
  -H "Authorization: Bearer $RELAY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "deepseek-v4",
    "messages": [
      {"role": "user", "content": "用一句话介绍 RelayAI"}
    ]
  }'
from openai import OpenAI

client = OpenAI(
    base_url="https://api.relayai.com.cn/v1",
    api_key="sk-relay-...",
)

resp = client.chat.completions.create(
    model="deepseek-v4",
    messages=[
        {"role": "user", "content": "你好,RelayAI"}
    ],
)
print(resp.choices[0].message.content)
import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "https://api.relayai.com.cn/v1",
  apiKey: process.env.RELAY_API_KEY,
});

const resp = await client.chat.completions.create({
  model: "deepseek-v4",
  messages: [{ role: "user", content: "你好,RelayAI" }],
});
console.log(resp.choices[0].message.content);

请求参数

参数类型说明
model 必填string模型标识,见 模型列表
messages 必填array对话消息列表,每条包含 rolecontent
streamboolean是否流式返回,默认 false
temperaturenumber采样温度,0–2,默认 1
max_tokensinteger生成内容的最大 token 数。

模型列表

通过统一标识调用任意模型,无需切换接口或密钥。智能路由会按可用性与时延自动选路。

模型标识归属合规状态
deepseek-v4 / deepseek-flash / deepseek-r1深度求索国产 · 已备案
qwen3.6-max / qwen3.6-plus通义千问国产 · 已备案
glm-5.1智谱国产 · 已备案
kimi-k2.6月之暗面国产 · 已备案
minimax-m2.7MiniMax国产 · 已备案
gpt-5.5OpenAI 兼容海外 · 企业授权
claude-opus-4.8Anthropic海外 · 企业授权

海外模型仅向通过审核的企业客户开放,限用于合法授权的研发、测试及内部业务场景,企业须自行确保业务合规。

流式输出

设置 stream: true,服务端以 SSE(Server-Sent Events)逐块返回,适合打字机式实时渲染。

stream = client.chat.completions.create(
    model="qwen3.6-max",
    messages=[{"role": "user", "content": "写一首诗"}],
    stream=True,
)
for chunk in stream:
    print(chunk.choices[0].delta.content or "", end="")

在编程工具中使用

由于接口与 OpenAI / Anthropic 完全兼容,主流 AI 编程工具与 Agent 均可直接接入 RelayAI——只需把工具的 base_url 指向 RelayAI,并填入企业密钥即可。下面给出常见工具的配置方式。

这些为第三方工具,配置项可能随版本变化,请以其官方文档为准。当工具调用 claude-*gpt-* 等海外模型时,须遵守海外模型「企业授权场景」的合规要求。

Claude Code
Anthropic 兼容 · 环境变量
# 写入 shell 配置或当前会话
export ANTHROPIC_BASE_URL="https://api.relayai.com.cn"
export ANTHROPIC_AUTH_TOKEN="sk-relay-..."
export ANTHROPIC_MODEL="claude-opus-4.8"
Cursor
OpenAI 兼容 · 设置项
# Settings → Models → Override OpenAI Base URL
Base URL   https://api.relayai.com.cn/v1
API Key    sk-relay-...
Model      deepseek-v4  # 添加为自定义模型
Hermes Agent
OpenAI 兼容 · 环境变量
export OPENAI_BASE_URL="https://api.relayai.com.cn/v1"
export OPENAI_API_KEY="sk-relay-..."
export OPENAI_MODEL="glm-5.1"
OpenClaw
OpenAI 兼容 · 配置文件
provider:  openai-compatible
base_url:  https://api.relayai.com.cn/v1
api_key:   sk-relay-...
model:     kimi-k2.6
opencode
OpenAI 兼容 · ~/.config/opencode/opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "provider": {
    "relayai": {
      "npm": "@ai-sdk/openai-compatible",
      "name": "RelayAI",
      "options": {
        "baseURL": "https://api.relayai.com.cn/v1",
        "apiKey": "sk-relay-..."
      },
      "models": {
        "deepseek-v4": { "name": "DeepSeek V4" },
        "qwen3.6-max": { "name": "Qwen 3.6 Max" }
      }
    }
  }
}

错误码

错误以标准 HTTP 状态码返回,响应体包含 error.typeerror.message

状态码含义处理建议
401密钥无效或缺失检查 Authorization 请求头。
403无该模型权限海外模型需企业授权,联系商务开通。
429触发限流Retry-After 退避重试。
402余额不足前往控制台充值或核对套餐额度。
500 / 503上游异常智能路由自动重试,可稍后再请求。

限流与计费

按实际消耗的 token 计费,控制台实时可查。默认限流为 3,500 RPM,企业客户可按需提升。

进入控制台 提交企业入驻