{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telnyx/main/json-schema/telnyx-conference-speak-request-schema.json",
  "title": "Conference Speak Request",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-conference-commands-api-openapi.yml#/components/schemas/ConferenceSpeakRequest",
  "properties": {
    "call_control_ids": {
      "description": "Call Control IDs of participants who will hear the spoken text. When empty all participants will hear the spoken text.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "command_id": {
      "description": "Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed.",
      "type": "string"
    },
    "language": {
      "description": "The language you want spoken. This parameter is ignored when a `Polly.*` voice is specified.",
      "enum": [
        "arb",
        "cmn-CN",
        "cy-GB",
        "da-DK",
        "de-DE",
        "en-AU",
        "en-GB",
        "en-GB-WLS",
        "en-IN",
        "en-US",
        "es-ES",
        "es-MX",
        "es-US",
        "fr-CA",
        "fr-FR",
        "hi-IN",
        "is-IS",
        "it-IT",
        "ja-JP",
        "ko-KR",
        "nb-NO",
        "nl-NL",
        "pl-PL",
        "pt-BR",
        "pt-PT",
        "ro-RO",
        "ru-RU",
        "sv-SE",
        "tr-TR"
      ],
      "type": "string"
    },
    "payload": {
      "description": "The text or SSML to be converted into speech. There is a 3,000 character limit.",
      "type": "string"
    },
    "payload_type": {
      "default": "text",
      "description": "The type of the provided payload. The payload can either be plain text, or Speech Synthesis Markup Language (SSML).",
      "enum": [
        "text",
        "ssml"
      ],
      "type": "string"
    },
    "region": {
      "$ref": "#/$defs/ConferenceRegion"
    },
    "voice": {
      "description": "Specifies the voice used in speech synthesis.\n\n- Define voices using the format `<Provider>.<Model>.<VoiceId>`. Specifying only the provider will give default values for voice_id and model_id.\n\n **Supported Providers:**\n- **AWS:** Use `AWS.Polly.<VoiceId>` (e.g., `AWS.Polly.Joanna`). For neural voices, which provide more realistic, human-like speech, append `-Neural` to the `VoiceId` (e.g., `AWS.Polly.Joanna-Neural`). Check the [available voices](https://docs.aws.amazon.com/polly/latest/dg/available-voices.html) for compatibility.\n- **Azure:** Use `Azure.<VoiceId>` (e.g., `Azure.en-CA-ClaraNeural`, `Azure.en-US-BrianMultilingualNeural`, `Azure.en-US-Ava:DragonHDLatestNeural`). For a complete list of voices, go to [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery). Use `voice_settings` to configure custom deployments, regions, or API keys.\n- **ElevenLabs:** Use `ElevenLabs.<ModelId>.<VoiceId>` (e.g., `ElevenLabs.eleven_multilingual_v2.21m00Tcm4TlvDq8ikWAM`). The `ModelId` part is optional. To use ElevenLabs, you must provide your ElevenLabs API key as an integration identifier secret in `\"voice_settings\": {\"api_key_ref\": \"<secret_identifier>\"}`. See [integration secrets documentation](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret) for details. Check [available voices](https://elevenlabs.io/docs/api-reference/get-voices).\n- **Telnyx:** Use `Telnyx.<model_id>.<voice_id>` (e.g., `Telnyx.KokoroTTS.af`). Use `voice_settings` to configure voice_speed and other synthesis parameters.\n- **Minimax:** Use `Minimax.<ModelId>.<VoiceId>` (e.g., `Minimax.speech-02-hd.Wise_Woman`). Supported models: `speech-02-turbo`, `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Use `voice_settings` to configure speed, volume, pitch, and language_boost.\n- **Rime:** Use `Rime.<model_id>.<voice_id>` (e.g., `Rime.Arcana.cove`). Supported model_ids: `Arcana`, `Mist`. Use `voice_settings` to configure voice_speed.\n- **Resemble:** Use `Resemble.Turbo.<voice_id>` (e.g., `Resemble.Turbo.my_voice`). Only `Turbo` model is supported. Use `voice_settings` to configure precision, sample_rate, and format.\n- **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`, `Inworld.Max.Oliver`). Supported models: `Mini`, `Max`.\n- **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`, `ara`, `rex`, `sal`, `leo`.\n\nFor service_level basic, you may define the gender of the speaker (male or female).",
      "type": "string"
    },
    "voice_settings": {
      "description": "The settings associated with the voice selected",
      "oneOf": [
        {
          "$ref": "#/$defs/ElevenLabsVoiceSettings"
        },
        {
          "$ref": "#/$defs/TelnyxVoiceSettings"
        },
        {
          "$ref": "#/$defs/AWSVoiceSettings"
        },
        {
          "$ref": "#/$defs/MinimaxVoiceSettings"
        },
        {
          "$ref": "#/$defs/AzureVoiceSettings"
        },
        {
          "$ref": "#/$defs/RimeVoiceSettings"
        },
        {
          "$ref": "#/$defs/ResembleVoiceSettings"
        },
        {
          "$ref": "#/$defs/InworldVoiceSettings"
        },
        {
          "$ref": "#/$defs/XAIVoiceSettings"
        }
      ]
    }
  },
  "required": [
    "payload",
    "voice"
  ],
  "type": "object",
  "$defs": {
    "AWSVoiceSettings": {
      "properties": {
        "type": {
          "description": "Voice settings provider type",
          "enum": [
            "aws"
          ],
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "title": "AWS Voice Settings",
      "type": "object"
    },
    "AzureVoiceSettings": {
      "properties": {
        "api_key_ref": {
          "description": "The `identifier` for an integration secret that refers to your Azure Speech API key.",
          "type": "string"
        },
        "deployment_id": {
          "description": "The deployment ID for a custom Azure neural voice.",
          "type": "string"
        },
        "effect": {
          "description": "Audio effect to apply.",
          "enum": [
            "eq_car",
            "eq_telecomhp8k"
          ],
          "type": "string"
        },
        "gender": {
          "description": "Voice gender filter.",
          "enum": [
            "Male",
            "Female"
          ],
          "type": "string"
        },
        "region": {
          "description": "The Azure region for the Speech service (e.g., `eastus`, `westeurope`). Required when using a custom API key.",
          "type": "string"
        },
        "type": {
          "description": "Voice settings provider type",
          "enum": [
            "azure"
          ],
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "title": "Azure Voice Settings",
      "type": "object"
    },
    "ConferenceRegion": {
      "description": "Region where the conference data is located. Defaults to the region defined in user's data locality settings (Europe or US).",
      "enum": [
        "Australia",
        "Europe",
        "Middle East",
        "US"
      ],
      "type": "string"
    },
    "ElevenLabsVoiceSettings": {
      "properties": {
        "api_key_ref": {
          "description": "The `identifier` for an integration secret [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret) that refers to your ElevenLabs API key. Warning: Free plans are unlikely to work with this integration.",
          "type": "string"
        },
        "type": {
          "description": "Voice settings provider type",
          "enum": [
            "elevenlabs"
          ],
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "title": "ElevenLabs Voice Settings",
      "type": "object"
    },
    "InworldVoiceSettings": {
      "properties": {
        "type": {
          "description": "Voice settings provider type",
          "enum": [
            "inworld"
          ],
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "title": "Inworld Voice Settings",
      "type": "object"
    },
    "MinimaxVoiceSettings": {
      "properties": {
        "language_boost": {
          "default": null,
          "description": "Enhances recognition for specific languages and dialects during MiniMax TTS synthesis. Default is null (no boost). Set to 'auto' for automatic language detection.",
          "enum": [
            null,
            "auto",
            "Chinese",
            "Chinese,Yue",
            "English",
            "Arabic",
            "Russian",
            "Spanish",
            "French",
            "Portuguese",
            "German",
            "Turkish",
            "Dutch",
            "Ukrainian",
            "Vietnamese",
            "Indonesian",
            "Japanese",
            "Italian",
            "Korean",
            "Thai",
            "Polish",
            "Romanian",
            "Greek",
            "Czech",
            "Finnish",
            "Hindi",
            "Bulgarian",
            "Danish",
            "Hebrew",
            "Malay",
            "Persian",
            "Slovak",
            "Swedish",
            "Croatian",
            "Filipino",
            "Hungarian",
            "Norwegian",
            "Slovenian",
            "Catalan",
            "Nynorsk",
            "Tamil",
            "Afrikaans"
          ],
          "type": [
            "string",
            "null"
          ]
        },
        "pitch": {
          "default": 0,
          "description": "Voice pitch adjustment. Default is 0.",
          "type": "integer"
        },
        "speed": {
          "default": 1.0,
          "description": "Speech speed multiplier. Default is 1.0.",
          "format": "float",
          "type": "number"
        },
        "type": {
          "description": "Voice settings provider type",
          "enum": [
            "minimax"
          ],
          "type": "string"
        },
        "vol": {
          "default": 1.0,
          "description": "Speech volume multiplier. Default is 1.0.",
          "format": "float",
          "type": "number"
        }
      },
      "required": [
        "type"
      ],
      "title": "Minimax Voice Settings",
      "type": "object"
    },
    "ResembleSampleRate": {
      "default": "48000",
      "description": "Audio sample rate in Hz.",
      "enum": [
        "8000",
        "16000",
        "22050",
        "32000",
        "44100",
        "48000"
      ],
      "title": "Resemble Sample Rate",
      "type": "string"
    },
    "ResembleVoiceSettings": {
      "properties": {
        "format": {
          "default": "mp3",
          "description": "Output audio format.",
          "enum": [
            "wav",
            "mp3"
          ],
          "type": "string"
        },
        "precision": {
          "default": "PCM_32",
          "description": "Audio precision format.",
          "enum": [
            "PCM_16",
            "PCM_24",
            "PCM_32",
            "MULAW"
          ],
          "type": "string"
        },
        "sample_rate": {
          "$ref": "#/$defs/ResembleSampleRate"
        },
        "type": {
          "description": "Voice settings provider type",
          "enum": [
            "resemble"
          ],
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "title": "Resemble Voice Settings",
      "type": "object"
    },
    "RimeVoiceSettings": {
      "properties": {
        "type": {
          "description": "Voice settings provider type",
          "enum": [
            "rime"
          ],
          "type": "string"
        },
        "voice_speed": {
          "default": 1.0,
          "description": "Speech speed multiplier. Default is 1.0.",
          "format": "float",
          "type": "number"
        }
      },
      "required": [
        "type"
      ],
      "title": "Rime Voice Settings",
      "type": "object"
    },
    "TelnyxVoiceSettings": {
      "properties": {
        "type": {
          "description": "Voice settings provider type",
          "enum": [
            "telnyx"
          ],
          "type": "string"
        },
        "voice_speed": {
          "default": 1.0,
          "description": "The voice speed to be used for the voice. The voice speed must be between 0.1 and 2.0. Default value is 1.0.",
          "format": "float",
          "maximum": 2.0,
          "minimum": 0.1,
          "type": "number"
        }
      },
      "required": [
        "type"
      ],
      "title": "Telnyx Voice Settings",
      "type": "object"
    },
    "XAIVoiceSettings": {
      "properties": {
        "language": {
          "default": "auto",
          "description": "Language code, or `auto` to detect automatically.",
          "type": "string"
        },
        "type": {
          "description": "Voice settings provider type",
          "enum": [
            "xai"
          ],
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "title": "xAI Voice Settings",
      "type": "object"
    }
  }
}