mcpField
S
setup-api-key

setup-api-key

github.com/bolna-ai开发366 次安装2 天前更新
代码仓库

关于 setup-api-key

用于配置和验证 Bolna API 密钥的技能，介绍如何在控制台创建密钥、通过环境变量保存、执行连通性测试并排查常见认证错误。

主要功能

  1. 01通过 Bolna 控制台创建密钥
  2. 02将密钥存入环境变量
  3. 03通过连通性测试验证访问
  4. 04诊断常见认证错误

适用场景

  1. 01运行 Bolna 脚本前配置凭据
  2. 02检查 API 密钥能否访问账户
  3. 03排查 401、403 或 429 响应

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/bolna-ai/skills --skill setup-api-key

安装后在 Claude Code 中输入/setup-api-key确认已加载。

附带文件scripts/verify_key.py

详细介绍

设置 Bolna API 密钥

核心信息

  • 基础 URL：https://api.bolna.ai
  • 身份验证标头：Authorization: Bearer $BOLNA_API_KEY
  • 冒烟测试端点：GET /user/me
  • API 密钥在 Bolna 控制面板的 Developers 下创建。
  • 密钥只会显示一次。如果丢失，请删除并重新生成。
  • 子账户密钥以 sa- 开头。

工作流

  1. 询问用户是否已有 Bolna API 密钥。
  2. 如果没有，引导他们前往 https://platform.bolna.ai，打开 Developers 并创建密钥。
  3. 将密钥作为环境变量存储在本地，切勿放入已提交的文件中。
  4. 使用 GET /user/me 验证密钥。
  5. 如果验证失败，请区分环境变量缺失、密钥无效、密钥过期或已删除，以及账户访问权限不足等情况。

Shell 设置

export BOLNA_API_KEY="paste-key-here"

对于项目本地的 .env：

BOLNA_API_KEY=paste-key-here

确保 .env 已列入 .gitignore。

cURL 冒烟测试

curl --request GET \
  --url https://api.bolna.ai/user/me \
  --header "Authorization: Bearer $BOLNA_API_KEY"

预期格式：

{
  "id": "user-uuid",
  "name": "Account name",
  "email": "[email protected]",
  "wallet": 42.42,
  "concurrency": {
    "max": 10,
    "current": 0
  }
}

故障排除

  • 401：API 密钥缺失、格式错误、已删除或错误。
  • 403：密钥存在，但账户或子账户无法访问请求的资源。
  • 429：请求频率受限；使用指数退避重试。
  • $BOLNA_API_KEY 为空：告知用户在运行脚本的 Shell 会话中导出该变量。

脚本

运行随附的冒烟测试：

python3 setup-api-key/scripts/verify_key.py

另请参阅

  • https://raw.githubusercontent.com/bolna-ai/skills/main/references/bolna-core.md — 集中介绍基础 URL、标头、分页和速率限制。
  • manage-subaccounts — 介绍 sa- 前缀，以及主账户密钥与子账户密钥之间的区别。

评论

支持 Markdown