Skip to main content
GET
/
agents
List Agents
curl --request GET \
  --url https://voice-livekit.studio.lyzr.ai/v1/agents \
  --header 'x-api-key: <api-key>'
{
  "agents": [
    {
      "id": "157e1979970ee35b248c32d4",
      "config": {
        "agent_name": "<string>",
        "agent_description": "<string>",
        "engine": {
          "kind": "<string>",
          "stt": "<string>",
          "llm": "<string>",
          "tts": "<string>",
          "voice_id": "<string>",
          "language": "<string>"
        },
        "engine_pipeline": {},
        "engine_realtime": {},
        "prompt": "<string>",
        "agent_role": "<string>",
        "agent_goal": "<string>",
        "agent_instructions": "<string>",
        "dynamic_variables": {},
        "dynamic_variable_defaults": {},
        "conversation_start": {},
        "turn_detection": "<string>",
        "noise_cancellation": {},
        "knowledge_base": {},
        "managed_agents": {},
        "tools": [
          "<string>"
        ],
        "lyzr_tools": [
          {}
        ],
        "agent_id": "<string>",
        "user_id": "<string>",
        "session_id": "<string>",
        "preemptive_generation": true,
        "pronunciation_correction": true,
        "pronunciation_rules": {},
        "audio_recording_enabled": true,
        "vad_enabled": true,
        "avatar": {},
        "background_audio": {},
        "corrections": [
          {}
        ]
      },
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "shared": true
    }
  ]
}
Retrieve a paginated list of all voice agents associated with your authenticated organization or user account. This endpoint returns detailed configurations for each agent, including their underlying engine settings, configured tools, avatar integrations, and prompt instructions.
Authentication Required You must include your API key in the x-api-key header. Failing to do so will result in a 401 Unauthorized error.

​
Pagination Details

When fetching a large number of agents, use the query parameters to control your results:
  • limit: Defines how many agents to return in a single request.
  • offset: Defines how many agents to skip. For example, if you set limit=10 and offset=10, you will retrieve the second “page” of your agents (items 11 through 20).

​
The Agent config Object

The response payload contains an agents array. Each agent includes a heavily detailed config object which maps exactly to how the agent behaves in LiveKit. Key sections of this config include:
  • Engine Specs: Outlines the specific LLM, STT (Speech-to-Text), and TTS (Text-to-Speech) pipelines powering the agent.
  • Knowledge Base: Details any connected Lyzr RAG or Agentic RAG sources the agent uses for context.
  • Avatar & Audio: Contains settings for visual avatars (e.g., HeyGen, Tavus, Simli) and background/ambient audio configurations.
  • Behavioral Prompts: Defines the agent’s specific role, goals, and dynamic variables injected at runtime.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
limit
integer

The maximum number of agents to return.

Example:

2

​
offset
integer

The number of agents to skip before starting to collect the result set.

Example:

1

Response

Agent list retrieved successfully

​
agents
object[]