Skip to main content
GET
/
config
/
realtime-options
List Realtime Options
curl --request GET \
  --url https://voice-livekit.studio.lyzr.ai/v1/config/realtime-options \
  --header 'x-api-key: <api-key>'
{
  "providers": [
    {
      "providerId": "openai",
      "displayName": "OpenAI",
      "models": [
        {
          "id": "gpt-realtime",
          "name": "gpt-realtime",
          "languages": [
            "en"
          ]
        }
      ],
      "voices": [
        {
          "id": "alloy",
          "name": "Alloy",
          "description": "Neutral and balanced",
          "previewUrl": "https://gstatic.com/aistudio/voices/samples/Zephyr.wav"
        }
      ],
      "requiredEnv": [
        "OPENAI_API_KEY"
      ]
    }
  ]
}
Retrieve the complete catalog of supported realtime voice providers and their respective capabilities. Our engine aggregates multiple state-of-the-art Voice AI providers into a single interface. This endpoint acts as a “discovery” route, returning all the configuration data you need to build dynamic agent-creation forms in your own UI.
Authentication Required: You must include your API key in the x-api-key header to authenticate this request.

​
Understanding the Configuration Payload

A successful request returns a providers array. Currently, the API supports leading realtime engines including OpenAI, Gemini, Ultravox, and xAI Grok. Each provider object contains the following nested data:
  • models: The specific realtime models available (e.g., gpt-realtime, gemini-2.5-flash-native-audio).
  • languages: Found inside each model object, this is an extensive array of supported ISO language codes (like en, es, hi, ja) indicating what languages the model can natively understand and speak.
  • voices: The available voice identities you can apply to the agent.

Authorizations

​
x-api-key
string
header
required

Response

200 - application/json

Realtime options retrieved successfully.

​
providers
object[]