API Key 管理

API Key 用来识别调用来自哪个账户。除了插件市场安装,其他接入方式(MCP、CLI、HTTP 接口、对话式安装)都需要 API Key。

创建 Key

  1. 登录后打开 API Keys 页面。
  2. 点「创建 API key」,填一个便于识别的名称,比如"Claude Code - 工作电脑"。
  3. 复制生成的 Key,保存到安全的地方。

建议每个客户端或每个使用场景单独建一个 Key。这样查账户时能通过 key_name 区分来源,某个 Key 泄露时也能单独停用,不影响其他客户端。

在环境变量里使用

统一使用环境变量名 AGENTEARTH_API_KEY:

export AGENTEARTH_API_KEY="<你的 API Key>"

在命令里引用时用双引号,单引号里的变量不会被展开:

--header "X-Api-Key: $AGENTEARTH_API_KEY"

停用、启用与删除

操作 效果
停用 使用这个 Key 的调用立即失败;之后可以随时重新启用
启用 恢复使用,Key 本身不变,不需要修改客户端配置
删除 永久删除,无法恢复;使用它的客户端需要换一个新 Key

不确定某个 Key 还有没有在用时,先停用观察,比直接删除更稳妥。

同时启用的数量上限

同时处于启用状态的、手动创建的 Key 有数量上限,具体数字显示在 API Keys 页面上。

  • 停用的 Key 不占名额。达到上限时,先停用一个不再使用的 Key,再启用或新建。
  • 插件市场授权生成的 OAuth 应用不计入上限(见下文)。
  • 已过期的 Key 无法重新启用,请新建一个。

插件市场授权生成的 OAuth 应用

通过 WorkBuddy、TRAE 等插件市场安装并授权后,API Keys 页面会出现一条标记为「OAuth 授权的应用」的记录,对应那个客户端。

  • 停用:对应客户端立即断开连接;重新启用即可恢复,不需要重新授权。
  • 删除:等于撤销该客户端的授权,客户端立即断开,需要在客户端里重新授权才能继续使用。

保管建议

  • 不要把 Key 写进代码仓库、截图或公开的聊天记录;用环境变量或客户端的密钥配置保存。
  • 分享屏幕、录制演示前,确认配置文件里的 Key 没有露出来。
  • 发现 Key 可能泄露时,立即在 API Keys 页面停用或删除,再新建一个替换。