# 管理 API Key

> 全部文档的索引见 [llms.txt](https://ark.volcengine.com/llms.txt)；在任一文档页面地址后追加 `.md` 可获取该页的 Markdown 版本。

当您通过代码调用大模型或应用时，需要 API Key 作为鉴权凭证。火山方舟控制台的 **API Key 管理** 页面可以帮助您创建和管理 API Key。如果您是第一次使用，建议先按 [快速入门](/docs/quick-start) 完成端到端调用流程。

## 功能入口

在控制台左下角选择 [API Key 管理](https://ark.volcengine.com/region:cn-beijing/apiKey?apikey=%7B%7D)。

在该页面您可以创建、查询、管理 API Key。

## 权限模型

API Key 提供以下能力：

| 能力 | 说明 |
| --- | --- |
| 按资源项目（Project）隔离调用权限 | 您可在控制台左下角切换资源项目，在不同项目中创建的 API Key 仅可作为该项目内资源的鉴权凭证。 |
| 全部权限 | 可访问一个资源项目下全部资源。 |
| 自定义权限 | 自定义指定部分资源的访问权限，灵活控制 API Key 对资源项目内特定资源的使用权限。当前支持从 **Model ID**、**自定义推理接入点** 维度进行细粒度的权限设置。 |
| IP 调用白名单 | 限制可调用模型的 IP 地址。启用后，仅添加至白名单的 IP 地址可调用模型。 |

## 创建 API Key

创建 API Key，作为调用大模型或应用的鉴权凭证。创建时根据业务需求选择上文 **权限模型** 中的能力组合。

## 查询 API Key

支持在 API Key 管理页面查询已有的 API Key，查看当前 API Key 的状态、权限、最后使用时间、创建人等信息。

> **注意**
>
> 请勿以任何方式公开 API Key，避免被他人使用造成安全风险或资金损失。

## 编辑权限

支持随时调整 API Key 可访问的权限范围，包括 IP 调用白名单、可访问的具体资源等，以满足不同场景下对 API Key 使用权限的灵活配置需求，确保系统安全与业务需求的平衡。

> **说明**
>
> API Key 权限控制与模型调用（Model ID、自定义推理接入点）相关的数据面 API 权限。如需设置管控面权限（**包括创建 API Key 的权限**），需使用访问控制 (IAM)，具体信息请参考 [使用 IAM 管理权限](/docs/use-iam-to-manage-permissions)。

![API Key 编辑权限面板](<https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/852b87d696a14c67aec17dc3bcc1e8af~tplv-goo7wpa0wc-image.image =690x>)

## 禁用 / 启用 API Key

* 禁用后，API Key 会变成 **已禁用** 状态，使用该 API Key 的请求将无法通过鉴权，请谨慎操作。
* 启用后，API Key 会变成 **生效中** 状态，可正常使用。

> **禁用 vs 删除**：禁用是**可恢复**的——您可随时重新启用同一个 API Key，键值不变。删除是**不可逆**的——已删除的 API Key 无法找回，且使用该 Key 的所有请求会立即鉴权失败。生产环境优先用禁用，确认 Key 不再使用后再删除。

## 安全设置

> 本节面向**项目管理员（主账号）**。普通项目成员（子账号）看不到本节描述的 **限制成员权限** 开关。

控制一个资源项目成员只能管理自己创建的 API Key，从而增强 API Key 管理的安全性和规范性。

默认情况下，项目成员（子账号）可查看并管理当前项目下的所有 API Key；如对权限有更严格的管控要求，项目管理员（主账号）可开启 **限制成员权限**。开启后，项目成员仅可查看、编辑、禁用/启用、删除自己创建的 API Key，无权操作他人创建的 API Key。

> 您需要在控制台左下角选择资源项目后，才能看到 **安全设置** 信息。

![安全设置开关](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/31d3c2efcfff47b1bfb6b0e219425683~tplv-goo7wpa0wc-image.image)

## 删除 API Key

当您不再使用 API Key 进行鉴权时，可删除以避免后续被误用。

## 配额限制

一个主账号下支持创建 50 个 API Key。
如需更多配额，可在控制台左下角选择 **系统设置** > **项目配置** > **配额管理** > **其他** 申请配额。

**注**：此操作需要配额中心的操作权限。

![申请配额入口](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/c74c4527ac3341adb21541da31134509~tplv-goo7wpa0wc-image.image)

## 下一步

获取 API Key 后，您可以：

* [快速入门](/docs/quick-start)：完成第一次端到端调用，验证 API Key 可用。
* [文本生成](/docs/text-generation)：了解 Chat Completions API 的完整能力。