Skip to main content

API Overview

The Nimbus REST API is available at https://api.get-nimbus.com.

Authentication

Pass your API key in the X-API-Key header:

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

Rate limits

TierTasks / month
Free10
ProUnlimited

Other endpoints (listing tasks, checking status, managing skills) are not rate-limited.

Interactive docs

The full OpenAPI spec with a Swagger UI is available at:

https://api.get-nimbus.com/docs

ReDoc format:

https://api.get-nimbus.com/redoc

Endpoint groups

GroupBase pathDescription
Tasks/tasks/Create and manage tasks
Agents/agents/List and run built-in agents
Skills/skills/Manage custom skills
Prism/prism/Parse specs and queue tasks
Automations/automations/Manage event-driven automations
Repos/repos/Manage repos and memory
Workspaces/workspaces/Manage workspaces
Keys/keys/Manage API keys

WebSocket

Live task logs are streamed over WebSocket:

wss://api.get-nimbus.com/tasks/{task_id}/ws

See Tasks API for details.