API Key 凭据用于托管第三方服务颁发的固定访问密钥,避免将密钥硬编码到业务代码、容器镜像或本地配置文件中。
本文介绍如何在 AgentKit 控制台中创建 API Key 类型的凭据,完成凭据名称、API Key 值、密钥存储方式、加密方式等配置,使 Agent 能够安全地使用该凭据访问第三方服务。
说明
在控制台创建凭据后,普通 HTTP 请求不会自动携带 API Key。使用凭据前,还需要完成出站代理或 SDK 接入,并配置凭据与 Agent 的绑定关系及取用权限。
- 出站代理接入:适用于通过 MCP 服务、网关或统一代理访问下游 API 的场景。了解更多
- SDK 或接口接入:适用于 Agent 业务代码直接调用第三方 API 的场景。了解更多
- 当 Agent 需要调用使用固定 API Key 进行身份认证的第三方模型、搜索服务、数据库服务或业务 API 时,可以创建 API Key 凭据。平台会在 Agent 发起出站请求时按配置注入密钥,使 Agent 能够完成目标服务认证。
- 若不希望在 Agent 代码、代码仓库、镜像、配置文件或运行参数中保存 API Key 明文,可通过 API Key 凭据将密钥与业务代码解耦,避免敏感信息随代码流转或被误提交。
- 当业务对密钥安全、审计或生命周期管理有要求时,可通过 KMS 主密钥对凭据进行加密,或使用凭据托管服务统一存储和管理凭据。以此降低密钥泄露风险,并便于后续进行凭据更新、轮换。
- 当同一凭据需要按业务项目、环境或资源归属进行管理时,可为凭据配置所属项目。同时,可将凭据绑定到指定 Agent,限定引用该凭据的 Agent,避免凭据被不相关的 Agent 使用。
- 已从目标服务提供方获取可用的 API Key,并确认该密钥具备 Agent 调用目标服务所需的权限。建议同时确认密钥的适用环境、有效期、调用额度、访问范围及是否存在 IP 白名单等限制,避免创建完成后因密钥权限不足或环境不匹配导致调用失败。
- 若在创建凭据时选择使用“自定义主密钥”进行加密,请先在 KMS 中创建可用的密钥环和主密钥,并确认当前账号具备使用该主密钥加密和解密凭据的权限。详情请参见 密钥管理快速入门。
说明
若暂无需自主管理密钥,可选择系统默认密钥,由平台托管加密配置,以减少额外准备工作。
- 若希望在创建凭据过程中立即完成绑定,请提前创建需要使用该凭据的 目标 Agent。绑定后,目标 Agent 才能在运行时引用该凭据完成出站调用。
说明
若暂时不确定需要绑定的 Agent,也可以先完成凭据创建后再进行 Agent 绑定。 - 在左侧导航树,选择“身份与权限 > 凭据管理”。
- 单击“新建凭据”按钮,并在“选类型”页面选择“API Key”。
-
-
- 确认参数配置无误后,单击“创建并继续”按钮,进入绑定到 Agent 页面。
将凭据绑定到 Agent 后,目标 Agent 才能在运行时引用该凭据完成出站调用。为遵循最小授权原则,建议仅绑定确有调用需求的 Agent,避免扩大凭据的使用范围。
说明
如果暂时无法确定需要授权的 Agent,可以跳过本步骤,先完成凭据创建,后续再进入凭据详情页补充绑定。相关操作请参见 绑定与解绑 Agent。 - 在 Agent 列表中选择需要使用该凭据的目标 Agent。
-
- 确认所选 Agent 无误后,单击“下一步”按钮。
如暂不绑定,可不选择任何 Agent,直接单击“下一步”按钮进入后续流程。
页面显示凭据创建成功,表示系统已完成凭据保存。结束创建流程前,请确认页面展示的凭据名称与预期一致,避免因名称填写错误而影响后续查找和使用。
- 如需核对凭据类型、所属项目、绑定资源或其他配置信息,单击“查看凭据详情”按钮,进入详情页进行检查。
若希望快速接入且无独立密钥管理要求,可选择系统默认密钥;若业务要求自主管理密钥、独立审计或满足特定合规要求,可选择自定义主密钥。
不是。也可以凭据保存后可直接进入下一步,后续在凭据详情中完成绑定。
请检查密钥是否有效、Agent 是否已绑定、传递方式是否正确,以及 KMS 主密钥和身份池权限是否满足要求。必要时在目标服务侧查看认证失败信息。
凭据是否可以通过所属项目和智能体身份池来管理资源归属?
所属项目与智能体身份池属于凭据的归属、隔离标识信息,用于标记凭据所属业务范围,记录凭据的创建与使用上下文。
说明
所属项目和智能体身份池仅用于描述资源归属与隔离范围,不属于运行时授权判定依据。配置项目或身份池,不代表已自动完成统一授权,也不能仅凭这两个字段判断 Agent 运行时是否有权使用该凭据。Agent 运行时能否取用凭据,还需结合凭据状态、绑定关系及运行时取用授权等配置综合判断。
只要选择了所属项目或智能体身份池,就能判断 Agent 执行时一定能使用该凭据吗?
不能。所属项目和智能体身份池只能反映凭据的归属范围或隔离上下文,不能单独作为运行时可用性的判断依据。实际是否可用,还需结合凭据绑定关系、凭据状态、类型匹配及运行时授权配置综合判断。
凭据的管理权限,和 Agent 运行时取用凭据的权限,是同一类权限吗?
不是。二者分属不同层面的授权能力,相互独立,需要分开配置。
二者存在关联,但权限不可互相替代:拥有凭据管理权限,不代表对应的 Agent 运行时就能够取用凭据;反之,Agent 运行时可以取用凭据,也不代表操作者拥有该凭据的管理权限。
- 控制控制台侧的操作权限,定义谁能够查看、新建、编辑、删除与维护凭据资产,一般对应控制台管理面的 IAM 权限。
- 控制运行时执行阶段的使用权限,定义指定 Agent 在执行任务、调用下游服务时,是否允许读取并使用该凭据。