VoiceDesignResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/telnyx/json-schema/telnyx-voice-design-response-schema.json",
  "title": "VoiceDesignResponse",
  "description": "Response envelope for a single voice design with full version detail.",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-voice-designs-api-openapi.yml#/components/schemas/VoiceDesignResponse",
  "properties": {
    "data": {
      "$ref": "#/$defs/VoiceDesignData"
    }
  },
  "type": "object",
  "$defs": {
    "VoiceDesignData": {
      "description": "A voice design object with full version detail.",
      "properties": {
        "created_at": {
          "description": "Timestamp when the voice design was first created.",
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "description": "Unique identifier for the voice design.",
          "format": "uuid",
          "type": "string"
        },
        "name": {
          "description": "Name of the voice design.",
          "type": "string"
        },
        "prompt": {
          "description": "Natural language prompt used to define the voice style for this version.",
          "type": "string"
        },
        "provider": {
          "description": "Voice synthesis provider used for this design.",
          "enum": [
            "telnyx",
            "minimax",
            "Telnyx",
            "Minimax",
            null
          ],
          "type": [
            "string",
            "null"
          ]
        },
        "provider_supported_models": {
          "description": "List of TTS model identifiers supported by this design's provider (e.g. `Qwen3TTS`, `speech-02-turbo`).",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "provider_voice_id": {
          "description": "Provider-specific voice identifier. For Telnyx designs this is the design version ID; for Minimax it is the Minimax-assigned voice ID.",
          "type": [
            "string",
            "null"
          ]
        },
        "record_type": {
          "description": "Identifies the resource type.",
          "enum": [
            "voice_design"
          ],
          "type": "string"
        },
        "text": {
          "description": "Sample text used to synthesize this version.",
          "type": "string"
        },
        "updated_at": {
          "description": "Timestamp when the voice design was last updated.",
          "format": "date-time",
          "type": "string"
        },
        "version": {
          "description": "Version number of this voice design.",
          "type": "integer"
        },
        "version_created_at": {
          "description": "Timestamp when this specific version was created.",
          "format": "date-time",
          "type": "string"
        },
        "voice_sample_size": {
          "description": "Size of the voice sample audio in bytes.",
          "type": "integer"
        }
      },
      "type": "object"
    }
  }
}