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

# 认证

> 推理接口使用 API Key，管理接口使用管理密钥，均通过 Bearer 认证。

`/v1/models` 与 `/v1/chat/completions` 使用 API Key；`/v1/manage/*` 使用管理密钥，详见[管理 API](https://omnirelay.ai/docs/cn/general/management-api.md)。`GET /health` 为公开接口。

```bash theme={null}
Authorization: Bearer $OMNIRELAY_API_KEY
```

## 创建 API Key

1. 登录[控制台](https://omnirelay.ai/login)。
2. 确认**总览 → 真实模型服务**已经开通。未开通时推理 Key 和管理密钥的创建入口禁用，请先申请开通；充值本身不代表开通完成。
3. 打开 **API Keys**，用易于识别的名称创建 API Key。
4. 立即复制 API Key。

> [!WARNING]
>
> 创建时请复制 API Key。之后如需再次查看，可在列表中点击**查看**，并用通行密钥或邮箱验证码确认是你本人。在支持再次查看之前创建的 Key 只保存了 SHA-256 哈希，无法再显示，轮换后即可得到可查看的新 Key。

## 撤销 API Key

在控制台撤销后，下一次请求即失效。使用已撤销或不存在的 API Key 会返回：

```json theme={null}
{ "error": { "code": "unauthorized" } }
```

## API Key 随账户失效

API Key 归工作区内的某一个人所有，因此只在该账户有效期内可用。有两种工作区操作会直接吊销 API Key，无需任何人打开 API Key 列表：

* **所有者或管理员停用某个成员。** 该成员持有的所有 API Key 从下一次请求起返回 `401 unauthorized`。
* **成员注销自己的账户。** 注销会立即吊销其 API Key 并结束其会话。账户记录会保留一段宽限期以便对账，但 API Key 不会恢复。

两种情况下其他成员的 API Key 都不受影响。如果某个服务需要在负责人离开后继续运行，请用一个长期保留的账户为它签发 API Key。

## API Key 预算

可以为 API Key 设置可选的累计预算（单位 micro-USD）。真实调用需由 Key 可用预算覆盖费用预留，无法覆盖时返回 `402 inference_budget_or_access_denied`，其他 API Key 不受影响。

## 限定 Key 可调用的模型

可以让一个 Key 只调用它需要的模型。在**密钥设置**（或创建 Key 时）开启**只允许此 Key 调用选定的模型**，然后选择：

* **整个模型服务方**，例如 Anthropic 的全部模型。以后该模型服务方新增的模型也包含在内。
* **单个模型**，按模型 ID 选择。

开启限制后：

* 调用其他模型会返回 `403 model_not_allowed`。该请求会作为失败请求记录在**用量日志**中，不会扣费。
* `GET /v1/models` 只列出该 Key 可调用的模型，SDK 或工具不会再提供会被拒绝的模型。
* 轮换 Key 后限制保持不变。关闭限制即恢复可调用工作区的全部模型。

真实模型体验和 API 调试都使用你选择的 Key，执行该 Key 的模型、预算及到期限制。

## API Key 只放在服务端

* 使用环境变量或密钥管理服务保存 API Key。
* 不要把 API Key 放进浏览器或移动端代码，也不要提交到代码仓库。
* 每个服务使用独立 API Key，泄露时可单独撤销而不影响其他服务。

## 控制台账户与会话

控制台登录使用浏览器会话，与推理 Key 和管理密钥分开。通过头像菜单**添加账户**，再切换已保存账户；工作空间和余额不会合并。会话失效后需重新登录。退出当前浏览器账户不会撤销其 API Key，需要时在 **API Keys** 单独撤销。自己的登录记录位于**账户设置 → 登录日志**。详见[用户手册](https://omnirelay.ai/docs/cn/user-manual.md)和[数据处理](https://omnirelay.ai/docs/cn/general/data-handling.md)。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.