Skip to main content
本页用于验证 XRouter API Key、服务地址和模型名是否可用。无论你后续接入应用代码、Claude Code、Codex CLI 还是 CC-Switch,都建议先跑通一次最小请求。

前置条件

  • 已注册并登录 XRouter 控制台:https://api.xrouter.dev
  • 账户可正常访问模型页或控制台首页。
  • 本机已安装 curl;如果要运行 SDK 示例,还需要 Python 或 Node.js。

第一步:确认服务地址

控制台会展示当前可用的 API 服务地址。公共站默认是:
待补图片:控制台 API Info 面板,标出服务地址和复制按钮。截图中需要隐藏账号、余额和真实请求信息。
如果你的控制台显示了不同的 server_address,后续示例里的 https://api.xrouter.dev 都应替换成控制台显示的地址。

第二步:创建 API Key

进入控制台的 API Keys 页面,创建一把用于测试的 Key。创建时建议:
待补图片:创建 API Key 表单。截图必须使用假密钥,并隐藏账号、余额和任何真实业务名称。
API Key 属于敏感凭据。不要把真实 Key 提交到代码仓库、Issue、截图或聊天记录中。

配置环境变量

Terminal
复制命令时把 sk-your-api-key 替换成控制台生成的真实 API Key。如果你的控制台展示了不同服务地址,也请同步替换 XROUTER_BASE_URL

第三步:验证 API Key

先请求模型列表,确认密钥和地址可用:
Terminal
如果返回模型列表,说明 API Key 可以被 XRouter 识别。接着从控制台模型页复制一个可用模型 ID,用它发起一次 Chat Completions 请求。
待补图片:控制台模型页中复制模型 ID 的位置。第一版文档不维护完整模型清单,实际可用模型以控制台为准。

第四步:发起第一次请求

请求成功后,你可以继续配置 OpenAI SDK、Claude Code、Codex CLI 或 CC-Switch。模型名建议从控制台模型页复制,避免拼写差异。

下一步

选择接入方式

不确定该用哪种接口或工具时,从这里开始。

OpenAI SDK

在 Python、TypeScript 或其他 OpenAI SDK 中接入 XRouter。

Claude Code

配置 Claude Code 使用 XRouter 的 Anthropic Messages 入口。

Codex CLI

配置 Codex CLI 使用 XRouter 的 Responses API 入口。

常见问题

检查 API Key 是否包含完整 sk- 前缀,确认请求头格式是 Authorization: Bearer sk-...。如果你复制的是隐藏后的密钥,请重新在控制台查看或新建密钥。
先调用 /v1/models 查看当前密钥可用模型,再把工具中的模型名改成列表中存在的值。不同分组、Key 限制或账户状态可能影响可见模型。
先用本页的 cURL 验证网络和密钥。如果 cURL 成功,再检查工具是否把 base URL 写成了 https://api.xrouter.dev/v1https://api.xrouter.dev 对应的正确形式。