接入文档

快速接入 CodeRoute

CodeRoute 采用 OpenAI 兼容协议,直接复用 OpenAI SDK 或任意兼容客户端,只需替换 Base URL 与 API Key。

快速开始

三步完成接入:

  1. 注册账号,在控制台创建 API Key
  2. 把 Base URL 指向 https://api.coderoute.cc/v1
  3. 用 Kimi、GLM、Qwen 等模型发起请求

Base URL 与 API Key

  • Base URLhttps://api.coderoute.cc/v1
  • API Keysk-xxx(控制台「API Key 管理」创建)
  • 认证方式Authorization: Bearer <API Key>

curl 示例

bash
curl https://api.coderoute.cc/v1/chat/completions \
  -H "Authorization: Bearer $CODEROUTE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"kimi-k2.7-code","messages":[{"role":"user","content":"用 Python 写一个快速排序"}]}'

Python 示例

需安装 pip install openai

python
from openai import OpenAI

client = OpenAI(
    base_url="https://api.coderoute.cc/v1",
    api_key="sk-xxx",  # from the dashboard
)

resp = client.chat.completions.create(
    model="kimi-k2.7-code",
    messages=[{"role": "user", "content": "用 Python 写一个快速排序"}],
)
print(resp.choices[0].message.content)

Node 示例

需安装 npm install openai

javascript
import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "https://api.coderoute.cc/v1",
  apiKey: process.env.CODEROUTE_API_KEY,
});

const resp = await client.chat.completions.create({
  model: "kimi-k2.7-code",
  messages: [{ role: "user", content: "用 Python 写一个快速排序" }],
});
console.log(resp.choices[0].message.content);

Cursor 配置

Cursor 设置 → Models → OpenAI API:

  1. Base URL:https://api.coderoute.cc/v1
  2. API Key:控制台获取的 Key
  3. 在模型列表里添加 CodeRoute 的模型名(如 kimi-k2.7-code)
  4. Verify 验证连通

Codex 配置

Codex CLI 支持自定义模型提供方,在 ~/.codex/config.toml 中添加:

toml
# ~/.codex/config.toml
[model_providers.coderoute]
name = "CodeRoute"
base_url = "https://api.coderoute.cc/v1"
env_key = "CODEROUTE_API_KEY"

并设置环境变量 CODEROUTE_API_KEY。Codex 配置项随版本可能调整,以 Codex 官方文档为准。

关于支持的客户端

CodeRoute 当前提供 Kimi、GLM、Qwen 等 OpenAI 兼容编码模型,因此任何走 OpenAI 兼容协议的客户端均可接入(OpenAI SDK、Cursor、Codex 自定义提供方、Continue、Cline 等)。

Claude Code、Gemini CLI 等使用各自专用协议、需要对应模型账号的工具,将在 CodeRoute 接入对应模型后提供配置教程。