Skip to main content

API Keys

Generate a key

Via the CLI:

curl -X POST https://api.get-nimbus.com/keys/generate \
-H "Content-Type: application/json" \
-d '{"name": "my-key"}'

Response:

{
"id": "key_abc123",
"key": "nim-xxxxxxxxxxxxxxxxxxxx",
"name": "my-key",
"created_at": "2026-04-26T00:00:00Z"
}

Save the key value — it's only shown once.

You can also generate keys from the dashboard at get-nimbus.com/dashboard under Keys.

Store your key

export NIMBUS_API_KEY=nim-xxxxxxxxxxxxxxxxxxxx

Add this to your shell profile for persistence.

Use with the CLI

# Via environment variable (recommended)
nimbus run "task" --backend https://api.get-nimbus.com

# Via flag
nimbus run "task" --backend https://api.get-nimbus.com --api-key nim-...

Check usage

curl https://api.get-nimbus.com/keys/me \
-H "X-API-Key: $NIMBUS_API_KEY"

Response:

{
"id": "key_abc123",
"name": "my-key",
"tier": "free",
"tasks_this_month": 3,
"monthly_limit": 10,
"created_at": "2026-04-01T00:00:00Z"
}

Free vs Pro

FreePro
Tasks / month10Unlimited
AgentsAll 20All 20
SkillsUnlimitedUnlimited
AutomationsYesYes
IntegrationsGitHub, Slack, LinearGitHub, Slack, Linear

Revoke a key

curl -X DELETE https://api.get-nimbus.com/keys/<key-id> \
-H "X-API-Key: $NIMBUS_API_KEY"