Back to API Documentation

Staff API

User and agent management with role-based access

Version
1.0.0
Base URL
ws://hyperion:9999/staff-api
Endpoints
15

Endpoints

GET/api/v1/agents

List all agents with optional filtering

Parameters

status
string

Filter by status (active, inactive, scaling)

agentRole
string

Filter by role (Developer, Designer, etc.)

Response

{
  "agents": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "Code Assistant",
      "agentRole": "Developer",
      "status": "active",
      "replicas": 2,
      "config": {
        "aiProvider": "anthropic",
        "aiModel": "claude-3-opus",
        "maxTokens": 4000
      },
      "createdAt": "2025-01-07T10:00:00Z"
    }
  ],
  "total": 12
}
POST/api/v1/agents

Create a new agent

Request Body

{
  "name": "UI Designer",
  "agentRole": "Designer",
  "replicas": 1,
  "config": {
    "aiProvider": "anthropic",
    "aiModel": "claude-3-sonnet",
    "maxTokens": 2000
  }
}

Response

{
  "id": "507f1f77bcf86cd799439020",
  "name": "UI Designer",
  "agentRole": "Designer",
  "status": "active",
  "createdAt": "2025-01-08T16:00:00Z"
}
PUT/api/v1/agents/{agentId}/scale

Scale agent replicas

Request Body

{
  "replicas": 5
}

Response

{
  "agentId": "507f1f77bcf86cd799439011",
  "replicas": 5,
  "status": "scaling",
  "scaledAt": "2025-01-08T17:00:00Z"
}