Skip to content

Retrieve per-agent studio data

GET
/api/agent-communication/studio/data

Return one JSON entry per registered agent, merging capabilities and metrics.

Source of truth for the Agent Studio dashboard. Combines hub.agent_capabilities (identity, authority, availability) with hub.get_all_agent_metrics() (performance counters) into a single list-of-dicts payload.

Returns:

  • :class:StudioDataResponse with one :class:JsonDict per agent.

Raises:

  • HTTPException 503: Communication hub unavailable.
  • HTTPException 500: Unexpected hub error while building the payload.

Successful Response

StudioDataResponse

Studio data response model.

Provides comprehensive data for a multi-agent studio including all participating agents and their current state. Used for studio management endpoints to retrieve complete studio information.

Fields:

  • status: Operation status (success/error)
  • agents: List of dictionaries containing studio agent data including:
    • Agent ID and capabilities
    • Current status and workload
    • Participation history
    • Performance metrics

Usage: GET /api/agent-communication/studio-data returns this response model.

JSON Example:

{
  "status": "success",
  "agents": [
    {"agentId": "hawken", "status": "active", "workload": 0.5},
    {"agentId": "lagan", "status": "active", "workload": 0.3}
  ]
}
object
status
required
Status

Operation status

string
agents
required
Agents

Studio agent data

Array<object>

Arbitrary JSON-shaped data. Flattened from a recursive type alias for wiki rendering — the live API accepts any JSON-compatible value (string, number, bool, null, array, or nested object).

object
key
additional properties
any