Skip to content

Get all registered agents with capabilities

GET
/api/agent-communication/agents

Retrieve every agent registered with the communication hub.

Returns the live agent registry: each entry carries the agent’s capability list, specializations, display name, and computed authority level. Drives frontend dashboards and orchestration routing.

Returns:

  • status: Operation status indicator
  • total_agents: Count of registered agents
  • agents: Mapping of agent ID → :class:CommunicationHubAgentDiscoveryEntry
  • timestamp: ISO 8601 generation time

Raises:

  • HTTPException 503: If the communication hub is unavailable

Successful Response

AllAgentsResponse

All registered agents discovery response model.

Provides comprehensive listing of all agents registered in the communication hub with their capability data, total count, and discovery timestamp. Used for agent discovery endpoints and capability matching operations.

Fields:

  • status: Operation status (success/error)
  • total_agents: Total number of registered agents (non-negative integer)
  • agents: Dictionary mapping agent IDs to their capability data objects
  • timestamp: ISO 8601 timestamp of the discovery operation

Usage: GET /api/agent-communication/all-agents returns this response model.

JSON Example:

{
  "status": "success",
  "totalAgents": 9,
  "agents": {
    "hawken": {"capabilities": ["creative_writing"], "authority": "HIGH"},
    "lagan": {"capabilities": ["research"], "authority": "HIGH"}
  },
  "timestamp": "2025-01-31T10:30:00Z"
}
object
status
required
Status

Operation status

string
totalAgents
required
Totalagents

Total registered agents

integer
agents
required
Agents

Agent capability data by ID

object
key
additional properties
CommunicationHubAgentDiscoveryEntry

Structured agent discovery entry exposed by the communication hub.

object
agentId
required
Agentid

Registered agent ID

string
capabilities
required
Capabilities

Published capabilities

Array<string>
specializations
required
Specializations

Published specializations

Array<string>
agentName
required
Agentname

Display name for the agent

string
authorityLevel
required
Authoritylevel

Authority level from communication hub

string
timestamp
required
Timestamp

ISO timestamp

string