> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xrouter.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# 控制台与 API Key

> 了解 XRouter 控制台中的服务地址、API Key、模型限制、IP 限制和用量日志。

XRouter 的 API Key 用于所有兼容接口和工具接入。创建 Key 后，你可以用同一把 Key 调用 OpenAI 兼容接口、Anthropic Messages 入口和 Gemini 兼容入口。

## 服务地址

公共站默认服务地址为：

```text theme={null}
https://api.xrouter.dev
```

<Note>
  待补图片：控制台 API Info 面板，标出服务地址、复制按钮和延迟测试入口。截图中需要隐藏账号和真实业务信息。
</Note>

不同客户端需要填写的地址可能不同：

| 客户端类型        | 填写地址                         |
| ------------ | ---------------------------- |
| OpenAI SDK   | `https://api.xrouter.dev/v1` |
| Claude Code  | `https://api.xrouter.dev`    |
| Codex CLI    | `https://api.xrouter.dev/v1` |
| Gemini 兼容客户端 | `https://api.xrouter.dev`    |

<Tip>
  如果控制台显示了不同 `server_address`，请把表中的 `https://api.xrouter.dev` 替换成控制台展示的地址。
</Tip>

## 创建 API Key

在控制台的 API Keys 页面创建 Key。创建完成后请立即保存完整 Key，后续页面通常只会展示脱敏后的内容。

<Note>
  待补图片：创建 API Key 表单。截图必须使用假 Key，并隐藏账号、余额和任何真实业务名称。
</Note>

常见字段：

| 字段    | 作用                 |
| ----- | ------------------ |
| 名称    | 帮助你区分项目、环境或工具      |
| 剩余额度  | 用于限制这把 Key 可消耗的额度  |
| 无限额度  | 开启后不单独限制这把 Key 的额度 |
| 过期时间  | 到期后 Key 不再可用       |
| 模型限制  | 只允许这把 Key 调用指定模型   |
| IP 限制 | 只允许指定 IP 或 CIDR 访问 |
| 分组    | 使用账户可用分组中的某个路由分组   |

## 复制模型 ID

调用接口时，`model` 必须填写 XRouter 控制台中可用的模型 ID。

<Note>
  待补图片：模型页中搜索和复制模型 ID 的位置。第一版文档不维护完整模型清单，实际可用模型以控制台为准。
</Note>

建议：

* 从控制台复制模型 ID，避免大小写或后缀错误。
* 如果某把 Key 设置了模型限制，请确认目标模型在允许列表中。
* 如果工具报模型不可用，先用同一把 Key 请求 `/v1/models` 验证。

## 查看请求记录

请求失败时，控制台用量日志可以帮助你确认：

* 请求是否到达 XRouter。
* 使用了哪把 Key 和哪个模型。
* 返回状态、错误信息和消耗统计。
* 是否存在认证、模型权限或格式问题。

<Note>
  待补图片：用量日志筛选和请求详情界面。截图中需要隐藏真实 prompt、response、Key、用户信息和消费细节。
</Note>

## Key 安全建议

<Warning>
  不要在前端网页、移动端包体、公开仓库或公开截图中暴露真实 API Key。
</Warning>

建议做法：

* 本地开发使用环境变量或本机密钥管理工具。
* 服务端应用通过后端环境变量读取 Key。
* 为不同项目、环境和工具创建不同 Key。
* 泄露后立即删除旧 Key，并创建新 Key。
* 生产环境按需配置模型限制、额度限制、过期时间和 IP 限制。