List Agents

Get available agents for the project.

GET /v1/agents

cURL

curl -X GET https://api.astralform.ai/v1/agents \
  -H "X-API-Key: sk_live_your_api_key"

200

[
  {
    "name": "support-agent",
    "display_name": "Customer Support",
    "description": "Handles customer inquiries, refunds, and account issues.",
    "is_default": true,
    "is_enabled": true
  },
  {
    "name": "code-reviewer",
    "display_name": "Code Reviewer",
    "description": "Reviews code for bugs, security issues, and best practices.",
    "is_default": false,
    "is_enabled": true
  }
]

Returns enabled agents configured for this project. SDKs use this to discover available agents and route messages to specific ones.

Authentication

X-API-Key · string · required

Project API key (e.g., sk_live_... or sk_test_...)

Response

agents · array

Array of agent objects

Show Agent object

name · string

Agent identifier (lowercase with hyphens)

display_name · string

Human-readable name (optional)

description · string

What this agent specializes in (optional)

is_default · boolean

Whether this is the project’s default agent

is_enabled · boolean

Whether the agent is currently enabled

cURL

curl -X GET https://api.astralform.ai/v1/agents \
  -H "X-API-Key: sk_live_your_api_key"

200

[
  {
    "name": "support-agent",
    "display_name": "Customer Support",
    "description": "Handles customer inquiries, refunds, and account issues.",
    "is_default": true,
    "is_enabled": true
  },
  {
    "name": "code-reviewer",
    "display_name": "Code Reviewer",
    "description": "Reviews code for bugs, security issues, and best practices.",
    "is_default": false,
    "is_enabled": true
  }
]

Usage Notes

• Only enabled agents are returned
• Use agent_name in Chat Stream to route to a specific agent
• If no agent_name is provided, the default agent (or supervisor) handles the request