Edith API 密钥管理

使用 Unkey 管理 Edith 智能眼镜应用的 API 密钥。

设置

用户必须将 UNKEY_ROOT_KEY 和 UNKEY_API_ID 设置为环境变量。

• UNKEY_ROOT_KEY — 来自 Unkey 仪表盘的根密钥（用于创建/撤销密钥）
• UNKEY_API_ID — Unkey API ID，Edith 使用它来验证密钥

工具

此技能使用 curl 调用 Unkey REST API。所有请求均发送至 https://api.unkey.dev。

命令

创建新的 API 密钥

为插件开发者或设备创建密钥。可选择设置名称、过期时间或速率限制。

curl -s -X POST https://api.unkey.dev/v1/keys.createKey \
  -H "Authorization: Bearer $UNKEY_ROOT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "apiId": "'"$UNKEY_API_ID"'",
    "name": "{{name}}",
    "prefix": "edith",
    "meta": { "purpose": "{{purpose}}" },
    "expires": {{expires_unix_ms_or_null}},
    "ratelimit": {
      "async": true,
      "limit": {{rate_limit_per_second_or_10}},
      "duration": 1000
    }
  }'

响应中包含 key（请提供给用户）和 keyId（用于管理）。

列出所有密钥

curl -s "https://api.unkey.dev/v1/apis.listKeys?apiId=$UNKEY_API_ID" \
  -H "Authorization: Bearer $UNKEY_ROOT_KEY"

撤销密钥

通过 keyId 永久删除某个密钥。

curl -s -X POST https://api.unkey.dev/v1/keys.deleteKey \
  -H "Authorization: Bearer $UNKEY_ROOT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"keyId": "{{keyId}}"}'

验证密钥（只读检查）

curl -s -X POST https://api.unkey.dev/v1/keys.verifyKey \
  -H "Content-Type: application/json" \
  -d '{"apiId": "'"$UNKEY_API_ID"'", "key": "{{key}}"}'

更新密钥（重命名、更改速率限制、设置过期时间）

curl -s -X POST https://api.unkey.dev/v1/keys.updateKey \
  -H "Authorization: Bearer $UNKEY_ROOT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "keyId": "{{keyId}}",
    "name": "{{new_name}}",
    "ratelimit": {
      "async": true,
      "limit": {{new_limit}},
      "duration": 1000
    }
  }'

工作流程

当用户要求管理 Edith API 密钥时：

1. 检查环境变量 UNKEY_ROOT_KEY 和 UNKEY_API_ID 是否已设置。
2. 如果创建密钥：询问名称/用途，创建密钥并将密钥显示给用户（仅显示一次）。
3. 如果列出密钥：获取密钥列表并以表格形式显示，包含 keyId、名称、创建时间和状态。
4. 如果撤销：与用户确认 keyId，然后删除。
5. 插件通过 ?linkCode=...&apiKey=... 连接到 Edith WebSocket 中继——当中继服务器上设置了 UNKEY_API_ID 时，中继会自动通过 Unkey 验证该密钥。

示例

用户：“为我的演示插件创建一个 API 密钥”

curl -s -X POST https://api.unkey.dev/v1/keys.createKey \
  -H "Authorization: Bearer $UNKEY_ROOT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "apiId": "'"$UNKEY_API_ID"'",
    "name": "demo-plugin",
    "prefix": "edith",
    "meta": { "purpose": "demo plugin" },
    "ratelimit": { "async": true, "limit": 10, "duration": 1000 }
  }'