Skip to content
Ishvana Ishvana Docs

Retrieve the studio's agent list for UI rendering

GET
/api/agent-communication/studio/agents

Return the studio’s agent list with capabilities, specializations, and metrics.

Project-scoped — raises 503 when no project is active so the frontend can surface the “select a project” state instead of rendering a misleading global list under a placeholder studio id.

Returns:

  • :class:StudioAgentsResponse with studio_id equal to the active project’s id and a list of :class:StudioAgentInfo.

Raises:

  • HTTPException 503: No active project, or communication hub unavailable.
  • HTTPException 500: Unexpected hub error while building the list.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

StudioAgentsResponse

Studio agents list response model.

Provides list of all agents participating in a specific multi-agent studio with count and studio identification. Used for studio agent listing endpoints to retrieve agent participation information.

Fields:

  • status: Operation status (success/error)
  • studio_id: Unique identifier of the studio
  • agents: List of agent objects in the studio (may contain dynamic fields)
  • count: Total number of agents in studio (non-negative integer)

Usage: GET /api/agent-communication/studio/{studio_id}/agents returns this response model.

JSON Example:

{
  "status": "success",
  "studioId": "studio_123",
  "agents": [
    {"agentId": "hawken", "role": "writer"},
    {"agentId": "lagan", "role": "researcher"}
  ],
  "count": 2
}
object
status
required
Status

Operation status

string
studioId
required
Studioid

Studio identifier

string
agents
required
Agents

Studio agents list

Array<object>
StudioAgentInfo

Agent info for studio listings.

object
id
required
Id
string
name
required
Name
string
status
required
Status
string
Allowed values: online offline busy
capabilities
Capabilities
Array<string>
specializations
Specializations
Array<string>
metrics
Any of:
object
key
additional properties
Any of:
integer
description
Description
string
""
count
required
Count

Total agents count

integer