API Key概述

什么是API Key

API Key是调用AgentSphere API和SDK的认证凭证，通过API或SDK操作沙箱资源时（如创建沙箱模板、创建沙箱实例等），需携带API Key进行身份鉴权。

基本使用流程

API Key的使用流程可大致分为创建、配置、调用、停用/删除四个环节。具体如下：

1. 在控制台创建API Key，API Key仅在创建时显示一次，需立即妥善保存。
2. 获取API Key后，在SDK或API请求中配置认证信息，即可调用AgentSphere的各类接口操作沙箱资源。
3. 当API Key不再使用时，应及时删除。

图1 API使用流程

安全建议

• 妥善保管API Key：API Key生成后仅显示一次，请务必保存，切勿将API Key硬编码在代码中或提交到版本库，建议通过环境变量或密钥管理服务注入。
• 定期轮换：建议定期轮换API Key，降低泄露风险。
• 及时清理：不再使用的API Key应及时删除，避免遗留安全隐患。

相关文档

• 了解创建API Key的详细操作，请参见创建API Key。
• 管理已有API Key，请参见管理API Key。