Skip to main content
GET
/
agents
/
{agentId}
Get Agent Details
curl --request GET \
  --url https://voice-livekit.studio.lyzr.ai/v1/agents/{agentId} \
  --header 'x-api-key: <api-key>'
{
  "agent": {
    "id": "1bca24a70cf2e9fb0c722a35",
    "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": {
        "who": "<string>",
        "greeting": "<string>"
      },
      "turn_detection": "<string>",
      "noise_cancellation": {},
      "api_key": "<string>",
      "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": "2023-10-25T12:00:00Z",
    "updatedAt": "2023-10-26T12:00:00Z",
    "shared": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.lyzr.ai/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve the complete configuration profile of a specific Voice Agent. This endpoint is particularly useful when you need to audit an agent’s current settings, verify its configured LLM/TTS engine, or dynamically load its variables into your own application’s UI before starting a live session.
Authentication Required: You must include your API key in the x-api-key header.

​
Required Parameters

To fetch an agent, you must provide its agentId directly in the URL path.
  • agentId: The unique identifier generated when the agent was first created (e.g., 1bca24a70cf2e9fb0c722a35).

​
Understanding the Response

If the agent is successfully located, the API returns a 200 OK status with the full agent object.
  • id: Confirms the ID of the fetched agent.
  • config: The exact configuration dictionary powering the agent. This includes all prompt instructions (agent_role, agent_goal), configured voice/avatar models, and any connected tools or knowledge bases.
  • createdAt & updatedAt: Timestamps to help you track configuration changes over time.

​
Troubleshooting Common Errors

  • 400 Invalid agent id: This usually occurs if the ID string is malformed or not the correct length. Ensure there are no trailing spaces in your path.
  • 404 Agent not found: The format of the ID is correct, but no agent exists with this identifier in your organization. Double-check the ID or verify that the agent hasn’t been deleted.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
agentId
string
required

The unique 24-character identifier of the agent.

Example:

"1bca24a70cf2e9fb0c722a35"

Response

Agent found successfully.

​
agent
object