YUN API

对接文档

OpenAI / Claude 兼容入口/统一鉴权、渠道路由、日志统计

基础信息

Base URL正在读取浏览器地址
鉴权方式Authorization: Bearer sk-relay-XXXX-xxxxxxxxxxxxxxxx
OpenAI 入口POST /v1/chat/completions
Claude 入口POST /v1/messages
模型列表GET /v1/models
用量查询GET /api/v1/usage/:key?range=24h|7d|30d

OpenAI 接口示例

将客户端的基础地址指向本站的 /v1,并使用本站生成的 API 密钥。

bash
curl -X POST /v1/chat/completions \
  -H "content-type: application/json" \
  -H "authorization: Bearer sk-relay-XXXX-xxxxxxxxxxxxxxxx" \
  -d '{
    "model": "gpt-5-mini",
    "messages": [{ "role": "user", "content": "hello" }]
  }'

Claude 接口示例

Claude 兼容入口使用 Messages 格式。请求会根据模型和渠道类型路由到 Claude 上游。

bash
curl -X POST /v1/messages \
  -H "content-type: application/json" \
  -H "authorization: Bearer sk-relay-XXXX-xxxxxxxxxxxxxxxx" \
  -H "anthropic-version: 2023-06-01" \
  -d '{
    "model": "claude-haiku-4-5",
    "max_tokens": 512,
    "messages": [{ "role": "user", "content": "hello" }]
  }'

模型与渠道路由

  • OpenAI 接口只会选择 type=openai 的渠道。
  • Claude 接口只会选择 type=claude 的渠道。
  • 渠道的模型列表为空或包含 * 时,视为支持全部模型。
  • 多个可用渠道同时匹配时,按渠道权重选择;429、5xx、网络错误会自动切换备用渠道。

获取模型列表

对外模型列表使用标准兼容接口 GET /v1/models。OpenAI 请求只查询 OpenAI 渠道;Claude 请求只查询 Claude 渠道,两个模型商不会混在一起。API Key 允许全部渠道时,按请求头推断模型商;也可以用 provider=claude|openai 显式指定。

OpenAI 格式

bash
curl "/v1/models?provider=openai&format=openai"   -H "authorization: Bearer sk-relay-XXXX-xxxxxxxxxxxxxxxx"

返回示例:

json
{
  "object": "list",
  "data": [
    {
      "id": "gpt-5-mini",
      "object": "model",
      "created": 1780000000,
      "owned_by": "api-proxy"
    }
  ]
}

Claude 模型来源

bash
curl "/v1/models?provider=claude&format=claude"   -H "x-api-key: sk-relay-XXXX-xxxxxxxxxxxxxxxx"   -H "anthropic-version: 2023-06-01"

返回示例:

json
{
  "data": [
    {
      "id": "claude-haiku-4-5",
      "type": "model",
      "display_name": "claude-haiku-4-5",
      "created_at": "1970-01-01T00:00:00Z"
    }
  ],
  "object": "list"
}

用量查询

bash
curl "/api/v1/usage/sk-relay-XXXX-xxxxxxxxxxxxxxxx?range=24h"

返回请求数、输入/输出 Token、缓存 Token、成功/失败数量,以及按模型拆分的消耗。