API 密钥管理¶
API 密钥用于调用 AIGC 接口，请在 UPath 官网控制台进行管理。
管理入口¶
访问 UPath 官网控制台 进行 API 密钥的创建、查看和删除操作。
操作说明¶
创建密钥¶
- 登录 UPath 官网
- 进入控制台，点击「API 密钥」菜单
- 点击「创建密钥」按钮
- 输入密钥名称（可选，用于备注区分）
- 设置过期时间（可选，不设置则永不过期）
- 点击确认，保存生成的 API Key
妥善保管
API Key 创建后请妥善保管，不要泄露给他人。密钥仅在创建时显示一次。
查看密钥¶
在控制台「API 密钥」页面可以查看：
| 信息 | 说明 |
|---|---|
| 密钥名称 | 创建时设置的备注名称 |
| API Key | 密钥值（部分隐藏） |
| 状态 | active（正常）/ disabled（已禁用） |
| 创建时间 | 密钥创建时间 |
| 过期时间 | 密钥过期时间（如设置） |
| 最后使用时间 | 最近一次调用时间 |
删除密钥¶
- 在控制台「API 密钥」页面找到要删除的密钥
- 点击「删除」按钮
- 确认删除操作
立即生效
删除后该 API Key 立即失效，使用该 Key 的所有请求都将返回 401 错误。请确保您的应用已更换为其他有效密钥。
密钥状态说明¶
| 状态 | 说明 |
|---|---|
| active | 正常可用 |
| disabled | 已禁用，无法使用 |
使用方式¶
获取 API Key 后，在调用 AIGC 接口时通过请求头传递：
| 请求头 | 值 |
|---|---|
| X-API-Key | 你的 API Key |
详细使用方式请参考 认证方式。
常见问题¶
Q: 一个账号可以创建多少个 API Key？
A: 没有数量限制，可以根据业务需要创建多个。建议为不同的应用或环境创建独立的 Key。
Q: API Key 过期后会怎样？
A: 过期后该 Key 将无法使用，调用接口会返回 401 错误。请在控制台创建新的 Key。
Q: 如何延长 API Key 有效期？
A: 目前不支持修改过期时间，建议创建新的 Key。
Q: API Key 泄露了怎么办？
A: 立即在 官网控制台 删除该 API Key，然后创建新的 Key 并更新到您的应用中。