Skip to content

API 参考 ​

Router 数据面为 OpenAI / Anthropic 双生态兼容。本页列出端点、鉴权与通用行为;具体字段语义与各家官方 API 文档一致(OpenAI API / Anthropic Messages API)。

接入地址 ​

实际域名以控制台「快速接入」页展示为准,下文以 https://routerapi.<域名> 为占位。

协议Base URL端点
OpenAI Chat Completionshttps://routerapi.<域名>/v1POST /v1/chat/completions、GET /v1/models
OpenAI Responseshttps://routerapi.<域名>/v1POST /v1/responses
Anthropic Messageshttps://routerapi.<域名>/anthropicPOST /anthropic/v1/messages

鉴权 ​

所有端点都需要鉴权,Key 在控制台「API Keys」页签发:

  • OpenAI 协议:请求头 Authorization: Bearer <Key>
  • Anthropic 协议:请求头 x-api-key: <Key>(也兼容 Authorization: Bearer <Key>)

请求要点 ​

  • model(必填):控制台「可用模型」列表中的名称——智能路由池名或直调模型名
  • 流式:请求体带 "stream": true,响应为 SSE(data: 行逐块推送,以 data: [DONE] 结束;Anthropic 协议以其事件流格式返回)。OpenAI 协议流末会返回一个 usage 数据块(choices 为空数组),为本次调用的 token 用量;自行解析 SSE 的客户端请跳过该块
  • 其余参数(temperature、max_tokens、tools、tool_choice 等)与官方协议一致,按上游模型能力透传

响应头(路由观测) ​

响应头含义
x-veyra-routing-model本次实际落地执行的模型
x-veyra-routing-type路由形态(智能路由池 / 直调模型)
x-veyra-routing-reason本次选路原因(如权重分配 / 健康切换 / 故障升级)
x-veyra-routing-tier命中的路由档位
x-veyra-routing-score选路评分(4 位小数)
x-veyra-routing-escalated是否因上游故障升级到备用通道(true/false)
x-veyra-cls-type / x-veyra-cls-tier池调用的任务分类结果(任务类型 / 难度档,仅分类器介入时下发)
x-veyra-cls-confidence / x-veyra-cls-mode分类置信度 / 分类模式(同上)

价格表 ​

GET https://routerapi.<域名>/api/pricing —— 全部可用模型的对外价格表,无需鉴权(New API 兼容格式,可直接对接 New API 系的客户端与价格页)。

json
{
  "success": true,
  "data": [
    {
      "model_name": "auto-chat",
      "description": "",
      "quota_type": 0,
      "model_ratio": 5.0,
      "model_price": 0,
      "owner_by": "",
      "completion_ratio": 2.0,
      "enable_groups": ["default"],
      "supported_endpoint_types": ["openai", "openai-response", "anthropic"],
      "price_mode": "explicit"
    }
  ],
  "group_ratio": { "default": 1.0 },
  "usable_group": { "default": "default" },
  "pricing_version": "9f2c…"
}

字段口径:

  • 价格换算:model_ratio × 2 = 输入价(人民币元 / 1M tokens);输出价 = 输入价 × completion_ratio。价格与控制台同源同币(人民币),不经汇率换算。注意:New API 上游默认约定 model_ratio 单位为 USD,本端点为人民币——从其它 New API 系站点迁移的客户端如有按 USD 解读 ratio 的逻辑需相应调整
  • quota_type:恒为 0(按 tokens 计费)
  • price_mode:恒为 explicit。没有固定单价的模型不出现在价格表中(其费用以控制台「用量与账单」页为准)
  • pricing_version:价格内容指纹,价格变化时变化(客户端可据此决定是否刷新缓存)

错误码 ​

状态码含义处理建议
400 / 422请求体不合法(参数错误、超上下文等)按报错信息修正请求
401Key 缺失/无效/已删除检查鉴权头;到控制台确认 Key 状态
403Key 无权调用该模型(key_model_access_denied)确认请求的 model 在该 Key 的「可用模型」范围内;若该模型在控制台不可见,说明组织未被授权此模型范围,请联系平台
429超出 Key 限额(总额或日/周/月周期)周期限额响应带 Retry-After 头(秒),到窗口重置点自动恢复;总额限额用完即止,到控制台调高额度或清空已用量
5xx上游供应商故障(路由层已自动重试/切换)稍后重试;持续失败请联系官方支持

错误响应体为 JSON,含 error.message / error.type(Anthropic 协议)或 error.message / error.code(OpenAI 协议)字段。

限额的口径特性:

  • 按实际花费计量:限额消耗 = 响应落地后的实际计费成本(¥)——单次大调用本身可能超过剩余额度(放行后跑到底),其花费计入后后续调用将被拒绝
  • 失败不占额:调用失败(上游故障/参数错误)不产生成本、不计入限额用量
  • 周期边界:日/周/月为自然边界(东八区;周一起算),到点自动重置;周期之间独立计数(如「每日 ¥10 + 每月 ¥200」= 每天最多 10 且整月最多 200,任一先到即拒)
  • 在途超放:限额在调用前检查、响应后记账——同一时刻在途的调用可能使实际用量略超限额(与业界主流网关预算语义一致)

计费口径 ​

每次调用按实际 tokens 计量:价格表内的模型 = 输入 tokens × 输入价 + 输出 tokens × 输出价(¥/1M);其余模型按实际用量结算。明细见控制台「调用记录」,汇总见「用量与账单」。

维驭智能模型网关