API密钥

Ultralytics API密钥可实现远程训练、推理和自动化操作的安全程序化访问。针对不同使用场景创建具有特定权限的范围密钥。

创建 API 密钥

创建新的API密钥：

1. 前往设置 > API密钥
2. 点击创建密钥
3. 为该键输入名称
4. 选择权限范围
5. 点击创建

键名

为您的密钥命名一个描述性名称：

• training-server - 用于远程培训的机器
• ci-pipeline - 用于持续集成/持续交付（CI/CD）集成
• mobile-app - 用于移动应用程序

权限范围

选择作用域以限制关键权限：

主显示屏

创建后，该密钥仅显示一次：

密钥格式

API密钥遵循以下格式：

ul_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0

• 前缀: ul_ 识别Ultralytics密Ultralytics
• 正文：40个随机十六进制字符
• 总计：43个字符

使用 API 密钥

环境变量

将您的密钥设置为环境变量：

export ULTRALYTICS_API_KEY="ul_your_key_here"

$env:ULTRALYTICS_API_KEY = "ul_your_key_here"

在代码中

在您的Python 使用该密钥：

import os

# From environment (recommended)
api_key = os.environ.get("ULTRALYTICS_API_KEY")

# Or directly (not recommended for production)
api_key = "ul_your_key_here"

HTTP 头部

在API请求中包含密钥：

curl -H "Authorization: Bearer ul_your_key_here" \
  https://platform.ultralytics.com/api/...

远程培训

使用您的密钥启用指标流传输。

pip install "ultralytics>=8.4.0"

export ULTRALYTICS_API_KEY="ul_your_key_here"
yolo train model=yolo11n.pt data=coco.yaml project=username/project name=exp1

管理密钥

视图键

所有密钥均列于“设置 > API密钥”中：

撤销密钥

撤销已泄露或不再需要的密钥：

1. 点击键的菜单
2. 选择撤销
3. 确认撤销

重新生成密钥

如果密钥遭到泄露：

1. 创建具有相同作用域的新键
2. 更新您的应用程序
3. 撤销旧密钥

安全最佳实践

做

• 将密钥存储在环境变量中
• 为不同环境使用独立密钥
• 及时撤销未使用的密钥
• 使用最小必要作用域
• 定期轮换密钥

不要

• 将密钥提交到版本控制系统
• 在应用程序之间共享密钥
• 不必要地使用管理员作用域
• 在应用程序输出中记录密钥
• 在客户端代码中嵌入密钥

密钥轮换

定期轮换密钥以确保安全性：

1. 创建具有相同作用域的新密钥
2. 更新应用程序以使用新密钥
3. 验证应用程序是否正常运行
4. 撤销旧密钥

故障排除

无效密钥错误

Error: Invalid API key

解决方案：

1. 验证密钥是否已正确复制
2. 检查密钥是否已被撤销
3. 确保密钥具有所需作用域
4. 确认环境变量已设置

权限被拒绝

Error: Permission denied for this operation

解决方案：

1. 检查关键作用域是否包含所需权限
2. 请确认您是资源所有者
3. 创建具有正确作用域的新密钥

速率限制

Error: Rate limit exceeded

解决方案：

1. 降低请求频率
2. 实现指数退避算法
3. 联系客服申请额度提升

常见问题

我可以创建多少把钥匙？

API密钥没有硬性限制。您可以根据不同应用程序和环境的需求创建任意数量的密钥。

密钥会过期吗？

密钥不会自动过期。它们在被撤销前始终有效。出于安全考虑，建议实施密钥轮换机制。

创建后我能看到我的密钥吗？

不，完整密钥仅在创建时显示一次。若遗失，请创建新密钥并撤销旧密钥。

密钥是否具有区域限制？

密钥可在不同区域使用，但仅能访问您账户所在区域的数据。

我可以与团队成员共享密钥吗？

更佳做法：让每位团队成员创建自己的密钥。这能实现：

• 个人活动追踪
• 选择性撤销
• 适当的访问控制

📅 0 天前创建 ✏️ 0 天前更新

评论