Skip to main content

Agents API

GET /agents/​

List all built-in agents. Optionally filter by category:

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

# Security agents only
curl "https://api.get-nimbus.com/agents/?category=security" \
  -H "X-API-Key: $NIMBUS_API_KEY"

Response:

[
  {
    "name": "security-audit",
    "description": "Scan and fix OWASP Top 10 vulnerabilities across the codebase",
    "category": "security"
  },
  {
    "name": "test-coverage",
    "description": "Write tests for all uncovered functions, target 80% line coverage",
    "category": "testing"
  }
]

GET /agents/categories​

List available categories:

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

Response:

["security", "quality", "testing", "docs", "performance", "infra", "architecture"]

GET /agents/{name}​

Get full details for a specific agent:

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

Response:

{
  "name": "security-audit",
  "description": "Scan and fix OWASP Top 10 vulnerabilities across the codebase",
  "category": "security",
  "task_template": "Perform a comprehensive OWASP Top 10 security audit..."
}

POST /agents/{name}/run​

Run an agent. Creates a task and returns it:

curl -X POST https://api.get-nimbus.com/agents/security-audit/run \
  -H "X-API-Key: $NIMBUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "repo_id": "repo-xyz789",
    "workspace_id": "ws-abc123",
    "auto_approve": false
  }'

Returns the same task object as POST /tasks/. Use the task ID to poll status or connect via WebSocket.