mcpField
S
setup-api-key

setup-api-key

github.com/bolna-aiDevelopment366 installsUpdated 2d ago
Repository

About setup-api-key

A setup skill for configuring and verifying a Bolna API key. It explains dashboard key creation, environment-variable storage, a smoke test, and common authentication errors.

Key features

  1. 01Create a key through the Bolna dashboard
  2. 02Store the key in an environment variable
  3. 03Verify access with a smoke test
  4. 04Diagnose common authentication errors

Use cases

  1. 01Set up credentials before running Bolna scripts
  2. 02Check whether an API key can access the account
  3. 03Troubleshoot 401, 403, or 429 responses

Install

Copy the command and run it in a terminal.

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

After installing, type/setup-api-keyin Claude Code to confirm it loaded.

Bundled filesscripts/verify_key.py

Details

From the project README

Setup Bolna API Key

Core facts

  • Base URL: https://api.bolna.ai
  • Auth header: Authorization: Bearer $BOLNA_API_KEY
  • Smoke test endpoint: GET /user/me
  • API keys are created in the Bolna dashboard under Developers.
  • The key is shown only once. If it is lost, delete it and generate a new one.
  • Sub-account keys start with sa-.

Workflow

  1. Ask whether the user already has a Bolna API key.
  2. If not, guide them to https://platform.bolna.ai, open Developers, and create a key.
  3. Store it locally as an environment variable, never inside committed files.
  4. Verify it with GET /user/me.
  5. If verification fails, distinguish missing env var, invalid key, expired/deleted key, and insufficient account access.

Shell setup

export BOLNA_API_KEY="paste-key-here"

For a project-local .env:

BOLNA_API_KEY=paste-key-here

Make sure .env is in .gitignore.

cURL smoke test

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

Expected shape:

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

Troubleshooting

  • 401: missing, malformed, deleted, or wrong API key.
  • 403: key exists but the account or sub-account cannot access the requested resource.
  • 429: rate limited; retry with exponential backoff.
  • Empty $BOLNA_API_KEY: tell the user to export it in the shell session that will run scripts.

Script

Run the included smoke test:

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

See also

  • https://raw.githubusercontent.com/bolna-ai/skills/main/references/bolna-core.md — base URL, headers, pagination, rate limits in one place.
  • manage-subaccounts — the sa- prefix and the difference between parent vs sub-account keys.

Comments

Markdown supported