Voice Designs

Get a voice design

Changed on

Returns the latest version of a voice design, or a specific version when ?version=N is provided. The id parameter accepts either a UUID or the design name.

get/voice_designs/{id}

Request

  • Base URL
    https://api.telnyx.com/v2
  • URL
    https://api.telnyx.com/v2/voice_designs/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The voice design UUID or name.

Query parameters

versioninteger

Specific version number to retrieve. Defaults to the latest version.

Response

The requested voice design.

Example response

{
  "data": {
    "record_type": "voice_design",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "friendly-narrator",
    "version": 1,
    "text": "Hello, welcome.",
    "prompt": "Speak in a warm tone",
    "voice_sample_size": 48000,
    "version_created_at": "2024-01-01T00:00:00Z",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "provider": "Telnyx",
    "provider_supported_models": [
      "Qwen3TTS"
    ],
    "provider_voice_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Changes

  • a72569d69430Revision changes
    • warning

      added the new Minimax enum value to the / response property for the response status

    • warning

      added the new Telnyx enum value to the / response property for the response status