API Docs

XRoute 接入文档

XRoute 提供 OpenAI-compatible API。你可以保留现有 SDK，把 Base URL 和 API Key 换成 XRoute，即可完成模型调用、扣费和用量记录。

Base URL 与认证

Base URL: https://xroute.cloud/v1

所有 /v1/* 调用使用 Bearer Token：

Authorization: Bearer sk-live-...

curl 示例

curl https://xroute.cloud/v1/chat/completions \
  -H "Authorization: Bearer sk-live-..." \
  -H "Content-Type: application/json" \
  -d '{
    "model": "deepseek-v4-flash",
    "messages": [
      { "role": "user", "content": "hello xroute" }
    ]
  }'

OpenAI JavaScript SDK

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.XROUTE_API_KEY,
  baseURL: "https://xroute.cloud/v1"
});

const completion = await client.chat.completions.create({
  model: "deepseek-v4-flash",
  messages: [{ role: "user", content: "hello xroute" }]
});

console.log(completion.choices[0].message.content);

OpenAI Python SDK

from openai import OpenAI
import os

client = OpenAI(
    api_key=os.environ["XROUTE_API_KEY"],
    base_url="https://xroute.cloud/v1",
)

completion = client.chat.completions.create(
    model="deepseek-v4-flash",
    messages=[{"role": "user", "content": "hello xroute"}],
)

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

模型列表

控制台和首页价格表读取 /api/models。OpenAI-compatible 模型列表接口为 GET /v1/models，需要携带用户 API Key。

流式调用

当前支持 stream=true，返回 Server-Sent Events。

curl https://xroute.cloud/v1/chat/completions \
  -H "Authorization: Bearer sk-live-..." \
  -H "Content-Type: application/json" \
  -d '{
    "model": "deepseek-v4-flash",
    "stream": true,
    "messages": [
      { "role": "user", "content": "stream test" }
    ]
  }'

错误码

code含义
api_key_required缺少用户 API Key。
invalid_api_keyAPI Key 无效、被删除或未启用。
insufficient_balance余额不足，需充值或开通测试额度。
model_not_found模型不存在或未启用。
rate_limited触发 API Key 或 IP 限流。
upstream_error上游渠道返回错误。
admin_forbidden需要管理员权限。

充值与测试额度

新注册账号会获得少量测试额度，用于验证 API Key、模型调用、扣费和用量记录。余额不足时，可在控制台提交充值订单，管理员审核后入账。