{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/vonage/main/json-schema/vonage-start-talk-request-schema.json",
  "title": "StartTalkRequest",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/vonage-voice-openapi.yml#/components/schemas/StartTalkRequest",
  "type": "object",
  "required": [
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "description": "The text to read"
    },
    "language": {
      "$ref": "#/$defs/language"
    },
    "style": {
      "$ref": "#/$defs/style"
    },
    "premium": {
      "type": "boolean",
      "description": "Set to `true` to use the premium version of the specified style if available, otherwise the standard version will be used. You can find more information about Premium Voices in the [Text-To-Speech guide](https://developer.vonage.com/en/voice/voice-api/guides/text-to-speech#premium-voices).",
      "default": "false"
    },
    "voice_name": {
      "$ref": "#/$defs/voice_name"
    },
    "loop": {
      "type": "integer",
      "description": "The number of times to repeat the text the file, 0 for infinite",
      "default": 1
    },
    "level": {
      "type": "string",
      "description": "The volume level that the speech is played. This can be any value between `-1` to `1` in `0.1` increments, with `0` being the default.",
      "default": "0"
    }
  },
  "$defs": {
    "language": {
      "description": "The language to use",
      "type": "string",
      "default": "en-US",
      "enum": [
        "ar",
        "ca-ES",
        "cmn-CN",
        "cmn-TW",
        "cs-CZ",
        "cy-GB",
        "da-DK",
        "de-DE",
        "el-GR",
        "en-AU",
        "en-GB",
        "en-GB-WLS",
        "en-IN",
        "en-US",
        "en-ZA",
        "es-ES",
        "es-MX",
        "es-US",
        "eu-ES",
        "fi-FI",
        "fil-PH",
        "fr-CA",
        "fr-FR",
        "he-IL",
        "hi-IN",
        "hu-HU",
        "id-ID",
        "is-IS",
        "it-IT",
        "ja-JP",
        "ko-KR",
        "nb-NO",
        "nl-NL",
        "no-NO",
        "pl-PL",
        "pt-BR",
        "pt-PT",
        "ro-RO",
        "ru-RU",
        "sk-SK",
        "sv-SE",
        "th-TH",
        "tr-TR",
        "uk-UA",
        "vi-VN",
        "yue-CN"
      ]
    },
    "style": {
      "description": "The vocal style (vocal range, tessitura, and timbre) to use",
      "type": "integer",
      "default": 0
    },
    "voice_name": {
      "description": "<strong>DEPRECATED</strong> The voice & language to use",
      "type": "string",
      "deprecated": true,
      "default": "Kimberly",
      "enum": [
        "Aditi",
        "Agnieszka",
        "Alva",
        "Amy",
        "Astrid",
        "Bianca",
        "Brian",
        "Carla",
        "Carmen",
        "Carmit",
        "Catarina",
        "Celine",
        "Cem",
        "Chantal",
        "Chipmunk",
        "Conchita",
        "Cristiano",
        "Damayanti",
        "Dora",
        "Emma",
        "Empar",
        "Enrique",
        "Eric",
        "Ewa",
        "Felipe",
        "Filiz",
        "Geraint",
        "Giorgio",
        "Gwyneth",
        "Hans",
        "Henrik",
        "Ines",
        "Ioana",
        "Iveta",
        "Ivy",
        "Jacek",
        "Jan",
        "Jennifer",
        "Joana",
        "Joanna",
        "Joey",
        "Jordi",
        "Justin",
        "Kanya",
        "Karl",
        "Kendra",
        "Kimberly",
        "Laila",
        "Laura",
        "Lea",
        "Lekha",
        "Liv",
        "Lotte",
        "Lucia",
        "Luciana",
        "Mads",
        "Maged",
        "Maja",
        "Mariska",
        "Marlene",
        "Mathieu",
        "Matthew",
        "Maxim",
        "Mei-Jia",
        "Melina",
        "Mia",
        "Miguel",
        "Miren",
        "Mizuki",
        "Montserrat",
        "Naja",
        "Nicole",
        "Nikos",
        "Nora",
        "Oskar",
        "Penelope",
        "Raveena",
        "Ricardo",
        "Ruben",
        "Russell",
        "Salli",
        "Satu",
        "Seoyeon",
        "Sin-Ji",
        "Sora",
        "Takumi",
        "Tarik",
        "Tatyana",
        "Tessa",
        "Tian-Tian",
        "Vicki",
        "Vitoria",
        "Yelda",
        "Zeina",
        "Zhiyu",
        "Zuzana"
      ]
    }
  }
}