Integration Guide

把 XRoute 接入你的 AI 工具

一个 XRoute API Key，可以接入支持 OpenAI-compatible endpoint 的客户端、脚本和 SDK。注册后创建密钥，把 Base URL 换成 XRoute 即可开始测试。

创建 API Key 查看 API 文档
Base URL https://xroute.cloud/v1
Authorization Bearer sk-live-...
推荐测试模型 gpt-5.4-mini
Quick Start

四步完成接入

1. 注册账号

进入控制台，用邮箱和密码创建账号。新账号会有少量测试额度。

2. 创建 API Key

在「API 密钥」页创建密钥。密钥明文只展示一次，请立即复制保存。

3. 配置工具

选择 OpenAI-compatible / 自定义 OpenAI 地址，把 Base URL 和 Key 填进去。

4. 试跑调用

先用轻量模型发送一句测试 prompt，再根据场景切换 Claude、GPT、DeepSeek 等模型。

Clients

常用工具配置

Cursor / IDE 类工具

在模型或供应商设置中选择 OpenAI-compatible、自定义 OpenAI 或第三方 API。

  • Base URL: https://xroute.cloud/v1
  • API Key: 控制台创建的 sk-live-...
  • Model: gpt-5.4-mini 或 claude-sonnet-4.6

Cline / Roo Code

Provider 选择 OpenAI Compatible，填入 XRoute 地址和模型名。

  • API Provider: OpenAI Compatible
  • Base URL: https://xroute.cloud/v1
  • Model ID: 从控制台「模型价格」复制

Cherry Studio

新增一个自定义供应商，类型选择 OpenAI 兼容。

  • 供应商名称: XRoute
  • API 地址: https://xroute.cloud/v1
  • 密钥: 控制台 API Key

Codex 说明

XRoute API Key 不能登录 Codex 账号。只有当客户端支持自定义 OpenAI-compatible Base URL 时，才能接入 XRoute。

  • 当前推荐先测 /v1/chat/completions
  • Codex 专有链路如需 /v1/responses，会作为后续兼容项单独适配
SDK

OpenAI SDK 示例

JavaScript

import OpenAI from "openai";

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

const result = await client.chat.completions.create({
  model: "gpt-5.4-mini",
  messages: [{ role: "user", content: "hello xroute" }]
});

Python

from openai import OpenAI
import os

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

result = client.chat.completions.create(
    model="gpt-5.4-mini",
    messages=[{"role": "user", "content": "hello xroute"}],
)
Models

模型选择建议

gpt-5.4-mini默认测试、通用对话、轻量 Agent
claude-sonnet-4.6代码、长上下文、复杂推理
deepseek-v4-flash高性价比调用、批量任务
seedance-2.0-fast视频生成测试