Skip to main content
GET
/
agents
/
{agentId}
/
versions
List Agent Versions
curl --request GET \
  --url https://voice-livekit.studio.lyzr.ai/v1/agents/{agentId}/versions \
  --header 'x-api-key: <api-key>'
{
  "agent_id": "1bca24a70cf2e9fb0c722a35",
  "versions": [
    {
      "version_id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
      "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": [
          {}
        ]
      },
      "active": true,
      "created_at": "2023-10-25T12:00:00Z"
    }
  ]
}

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 a complete history of all configurations (versions) for a specific Voice Agent. Every time you update an agent’s settings—whether changing its LLM, modifying its prompt, or attaching a new tool—a new version is saved. This endpoint allows you to audit those changes or fetch older configurations.
Authentication Required: You must include your API key in the x-api-key header to authenticate this request.

​
Required Parameters

You must pass the target agent’s unique identifier in the URL.
  • agentId: The 24-character string ID of the agent whose version history you want to retrieve.

​
Understanding the Response

The API returns an array of versions belonging to the agent. Each object in this array represents a distinct snapshot in time:
  • version_id: A unique UUID for this specific configuration state.
  • active: A boolean flag (true or false). Only one version can be active at a time. The active version is the one currently used when initiating a new LiveKit session.
  • config: The full configuration dictionary (prompts, models, avatars, tools) exactly as it existed when this version was saved.
  • created_at: The timestamp of when this version was generated.

​
Common Use Cases

  1. Auditing/Debugging: If an agent suddenly starts behaving unexpectedly, you can list versions to compare the current active: true config against older, stable versions.
  2. Rollback Preparation: By fetching the version_id of an older, successful configuration, you can prepare your application to rollback or activate that previous state.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
agentId
string
required

The unique identifier of the agent.

Example:

"1bca24a70cf2e9fb0c722a35"

Response

Agent version list retrieved successfully.

​
agent_id
string
Example:

"1bca24a70cf2e9fb0c722a35"

​
versions
object[]