> ## Documentation Index
> Fetch the complete documentation index at: https://heygen-1fa696a7.mintlify.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Voice

> Returns details for a specific voice, including clone workflow status when available. Use this to poll a voice clone until its status is 'complete'.



## OpenAPI

````yaml /openapi/external-api.json get /v3/voices/{voice_id}
openapi: 3.1.0
info:
  title: HeyGen External API
  version: 1.0.0
  description: >-
    HeyGen's external API for programmatic AI video creation. See
    https://docs.heygen.com for full documentation.
  contact:
    name: HeyGen Product Infra
    url: https://heygen.com
servers:
  - url: https://api.heygen.com
    description: Production
security:
  - ApiKeyAuth: []
  - BearerAuth: []
tags:
  - name: Video Agent
    description: Create videos from text prompts using AI
  - name: Videos
    description: Create, list, retrieve, and delete videos
  - name: Voices
    description: Text-to-speech and voice management
  - name: Audio
    description: Search the background-music and sound-effects catalog
  - name: Video Translate
    description: Translate videos into other languages
  - name: User
    description: Account information and billing
  - name: Avatars
    description: List and manage avatars and looks
  - name: Assets
    description: Upload files for use in video creation
  - name: Webhooks
    description: Manage webhook endpoints and events
  - name: Lipsync
    description: Dub or replace audio on existing videos
  - name: Brand
    description: >-
      Brand-related resources — brand kits (colors, fonts, logos) and brand
      glossaries (custom term translations)
paths:
  /v3/voices/{voice_id}:
    get:
      tags:
        - Voices
      summary: Get Voice
      description: >-
        Returns details for a specific voice, including clone workflow status
        when available. Use this to poll a voice clone until its status is
        'complete'.
      operationId: getVoice
      parameters:
        - name: voice_id
          in: path
          required: true
          schema:
            type: string
          description: Unique voice identifier
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/VoiceDetailV3'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: authentication_failed
                  message: Invalid or expired API key. Verify your x-api-key header.
                  param: null
                  doc_url: null
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: voice_not_found
                  message: Voice not found.
                  param: null
                  doc_url: null
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: rate_limit_exceeded
                  message: >-
                    Too many requests. Retry after the duration specified in the
                    Retry-After header.
                  param: null
                  doc_url: null
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
components:
  schemas:
    VoiceDetailV3:
      description: Response payload for GET /v3/voices/{voice_id}.
      properties:
        voice_id:
          description: Unique voice identifier.
          title: Voice Id
          type: string
        name:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Display name of the voice. Only present when the voice record
            exists.
          title: Name
        language:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Primary language of the voice. Only present when the voice record
            exists.
          title: Language
        gender:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Gender of the voice (e.g., 'male', 'female'). Only present when the
            voice record exists.
          title: Gender
        preview_audio_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            URL to a short preview audio clip. Only present for completed
            voices.
          title: Preview Audio Url
        status:
          anyOf:
            - enum:
                - processing
                - complete
                - failed
              type: string
            - type: 'null'
          default: null
          description: Clone status. Only present for cloned voices.
          title: Status
        failure_message:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Error description. Only present when status is 'failed'.
          title: Failure Message
        support_pause:
          description: Whether the voice supports SSML pause/break tags.
          title: Support Pause
          type: boolean
        support_interactive_avatar:
          default: false
          description: Whether the voice supports interactive avatar streaming.
          title: Support Interactive Avatar
          type: boolean
        created_at:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Unix timestamp when the voice was created.
          title: Created At
      required:
        - voice_id
        - support_pause
      title: VoiceDetailV3
      type: object
    StandardAPIError:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code
          example: invalid_parameter
        message:
          type: string
          description: Human-readable error message
          example: Video not found
        param:
          type:
            - string
            - 'null'
          description: Which request field caused the error
        doc_url:
          type:
            - string
            - 'null'
          description: Link to error documentation
      required:
        - code
        - message
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: HeyGen API key. Obtain from your HeyGen dashboard.
    BearerAuth:
      type: http
      scheme: bearer
      description: OAuth2 bearer token.

````