API Key 使用指南

API Key 用于认证 REST API、MCP 和 DSH 接入请求。

创建

1. 登录 开发者控制台。
2. 填写便于识别的名称并创建 API Key。
3. 立即复制完整 Key。完整 Key 只显示一次。

已有 API Key 可直接使用平台后续新增的公开能力，无需重新创建。

使用

REST API 和 MCP 请求通过 Bearer Header 携带 API Key：

Authorization: Bearer arkme_<key-id>_<secret>

DSH 的配置方式参见 DSH 接入指南。

保存

• 将 Key 保存在服务端 Secret、环境变量或密钥管理服务中。
• 不要把 Key 写入浏览器前端代码、URL、日志或公开仓库。
• 不要向他人发送完整 Key。

删除

在开发者控制台删除不再使用或可能泄露的 Key。删除后，使用该 Key 的请求将无法继续通过认证；需要恢复调用时请创建新 Key 并更新调用方配置。