TtsVoiceListResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/videogen-io/json-schema/videogen-io-tts-voice-list-response-schema.json",
  "title": "TtsVoiceListResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/videogen-io-resources-api-openapi.yml#/components/schemas/TtsVoiceListResponse",
  "type": "object",
  "required": [
    "ttsVoices",
    "hasMore",
    "nextCursor"
  ],
  "properties": {
    "ttsVoices": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/TtsVoice"
      }
    },
    "hasMore": {
      "type": "boolean",
      "description": "When true, there are more voices available. Pass `nextCursor` as the `cursor` query param to fetch the next page."
    },
    "nextCursor": {
      "type": [
        "string",
        "null"
      ],
      "description": "Opaque cursor to fetch the next page. `null` when `hasMore` is false."
    }
  },
  "$defs": {
    "TtsVoice": {
      "type": "object",
      "description": "A text-to-speech voice.",
      "required": [
        "voiceId",
        "languageCode",
        "displayName",
        "displayGender",
        "supportsDirectToolExecution",
        "supportsAllLanguages",
        "isDeprecated"
      ],
      "properties": {
        "voiceId": {
          "type": "string",
          "description": "Voice id (e.g. `vg_voic_...`). Pass this or `displayName` as `voiceId` to `POST /v1/tools/text-to-speech`."
        },
        "languageCode": {
          "type": "string",
          "description": "Locale tag for the voice (e.g. `en-US`, `es-ES`)."
        },
        "displayName": {
          "type": "string",
          "description": "Human-readable voice name."
        },
        "displayGender": {
          "type": "string",
          "enum": [
            "MALE",
            "FEMALE",
            "NEUTRAL"
          ],
          "description": "Voice gender."
        },
        "accent": {
          "type": [
            "string",
            "null"
          ],
          "description": "Accent (e.g. `american`, `british`)."
        },
        "description": {
          "type": [
            "string",
            "null"
          ],
          "description": "Description of the voice."
        },
        "supportsDirectToolExecution": {
          "type": "boolean",
          "description": "When false, this voice cannot be used directly with `POST /v1/tools/text-to-speech`. All voices, regardless of this field, can be used in full video generation workflows such as script-to-video."
        },
        "supportsAllLanguages": {
          "type": "boolean",
          "description": "When true, this voice can synthesize text in any language regardless of its `languageCode`. When false, the voice only supports its listed language."
        },
        "isDeprecated": {
          "type": "boolean",
          "description": "When true, this voice is deprecated and may be removed in a future API version. Prefer non-deprecated voices for new integrations."
        }
      }
    }
  }
}