> ## Documentation Index
> Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a voice design

> 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.



## OpenAPI

````yaml /openapi/voice-designs.yml get /voice_designs/{id}
openapi: 3.1.0
info:
  title: Voice Designs API
  version: 2.0.0
  description: Create and manage AI-generated voice designs using natural language prompts.
  contact:
    email: support@telnyx.com
servers:
  - url: https://api.telnyx.com/v2
security:
  - bearerAuth: []
tags:
  - name: Voice Designs
    description: >-
      Create and manage AI-generated voice designs using natural language
      prompts.
paths:
  /voice_designs/{id}:
    get:
      tags:
        - Voice Designs
      summary: Get a voice design
      description: >-
        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.
      operationId: getVoiceDesign
      parameters:
        - name: id
          in: path
          required: true
          description: The voice design UUID or name.
          schema:
            type: string
        - name: version
          in: query
          required: false
          description: Specific version number to retrieve. Defaults to the latest version.
          schema:
            type: integer
            minimum: 1
      responses:
        '200':
          description: The requested voice design.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceDesignResponse'
        '401':
          description: Unauthorized — missing or invalid bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/voice-designs_ErrorResponse'
        '404':
          description: Voice design not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/voice-designs_ErrorResponse'
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Telnyx from 'telnyx';

            const client = new Telnyx({
              apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
            });

            const voiceDesign = await client.voiceDesigns.retrieve('id');

            console.log(voiceDesign.data);
        - lang: Python
          source: |-
            import os
            from telnyx import Telnyx

            client = Telnyx(
                api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
            )
            voice_design = client.voice_designs.retrieve(
                id="id",
            )
            print(voice_design.data)
        - lang: Go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/team-telnyx/telnyx-go\"\n\t\"github.com/team-telnyx/telnyx-go/option\"\n)\n\nfunc main() {\n\tclient := telnyx.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tvoiceDesign, err := client.VoiceDesigns.Get(\n\t\tcontext.TODO(),\n\t\t\"id\",\n\t\ttelnyx.VoiceDesignGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", voiceDesign.Data)\n}\n"
        - lang: Java
          source: >-
            package com.telnyx.sdk.example;


            import com.telnyx.sdk.client.TelnyxClient;

            import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

            import com.telnyx.sdk.models.voicedesigns.VoiceDesignRetrieveParams;

            import
            com.telnyx.sdk.models.voicedesigns.VoiceDesignRetrieveResponse;


            public final class Main {
                private Main() {}

                public static void main(String[] args) {
                    TelnyxClient client = TelnyxOkHttpClient.fromEnv();

                    VoiceDesignRetrieveResponse voiceDesign = client.voiceDesigns().retrieve("id");
                }
            }
        - lang: Ruby
          source: |-
            require "telnyx"

            telnyx = Telnyx::Client.new(api_key: "My API Key")

            voice_design = telnyx.voice_designs.retrieve("id")

            puts(voice_design)
        - lang: CLI
          source: |-
            telnyx voice-designs retrieve \
              --api-key 'My API Key' \
              --id id
components:
  schemas:
    VoiceDesignResponse:
      type: object
      description: Response envelope for a single voice design with full version detail.
      properties:
        data:
          $ref: '#/components/schemas/VoiceDesignData'
      example:
        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
    voice-designs_ErrorResponse:
      type: object
      description: Standard error response envelope.
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorObject'
      example:
        errors:
          - code: '10005'
            title: Resource not found
            detail: Voice design not found
    VoiceDesignData:
      type: object
      description: A voice design object with full version detail.
      properties:
        record_type:
          type: string
          enum:
            - voice_design
          description: Identifies the resource type.
        id:
          type: string
          format: uuid
          description: Unique identifier for the voice design.
        name:
          type: string
          description: Name of the voice design.
        version:
          type: integer
          description: Version number of this voice design.
        text:
          type: string
          description: Sample text used to synthesize this version.
        prompt:
          type: string
          description: >-
            Natural language prompt used to define the voice style for this
            version.
        voice_sample_size:
          type: integer
          description: Size of the voice sample audio in bytes.
        version_created_at:
          type: string
          format: date-time
          description: Timestamp when this specific version was created.
        created_at:
          type: string
          format: date-time
          description: Timestamp when the voice design was first created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the voice design was last updated.
        provider:
          type:
            - string
            - 'null'
          enum:
            - telnyx
            - minimax
            - Telnyx
            - Minimax
            - null
          description: Voice synthesis provider used for this design.
        provider_supported_models:
          type: array
          items:
            type: string
          description: >-
            List of TTS model identifiers supported by this design's provider
            (e.g. `Qwen3TTS`, `speech-02-turbo`).
        provider_voice_id:
          type:
            - string
            - 'null'
          description: >-
            Provider-specific voice identifier. For Telnyx designs this is the
            design version ID; for Minimax it is the Minimax-assigned voice ID.
    ErrorObject:
      type: object
      description: A single error object.
      properties:
        code:
          type: string
          description: Telnyx-specific error code.
        title:
          type: string
          description: Short, human-readable summary of the error.
        detail:
          type: string
          description: Detailed, human-readable explanation of the error.
        source:
          type: object
          description: Reference to the source of the error.
          properties:
            pointer:
              type: string
              description: A JSON Pointer (RFC 6901) to the field that caused the error.

````