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

# List Audio Voices

> Returns model-backed audio voices. With the default `type=private`, these are the voices in the caller's workspace, professional and instant, ordered newest first; `mode` tells them apart. With `type=public`, these are the voices HeyGen provides to every workspace, best first. Filter the public list with `language`, `gender` and `age`, or search it with `query`. A public page holds at most 50 voices. Use `limit` and `token` to retrieve additional pages. A token works only with the `type` and filters that returned it.



## OpenAPI

````yaml /openapi/external-api.json get /v3/models/audio/voices
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
    description: >-
      Create videos from a prompt or an avatar, then list, fetch, deliver and
      delete them
  - name: Avatar
    description: >-
      Create avatars and looks, record consent, and generate with the Avatar 6
      model
  - name: Voice
    description: Text to speech, speech to speech, and voice cloning
  - name: Audio
    description: Music, sound effects, transcription, stem separation and audio analysis
  - name: Image
    description: Generate images
  - name: Video editing
    description: >-
      Translate, lipsync, clip, analyze and remove filler words or backgrounds
      from existing videos
  - name: Video Agent
    description: Create videos from a prompt with an agent that plans, writes and edits
  - name: Templates
    description: Generate videos from reusable templates by replacing their variables
  - name: HyperFrames
    description: Render HyperFrames compositions into video
  - name: Brand
    description: >-
      Brand kits (colors, fonts, logos) and brand glossaries (term translations
      and pronunciations)
  - name: Assets and folders
    description: Upload files and organize them in folders
  - name: Batches
    description: Submit and track videos, translations, lipsyncs and uploads in bulk
  - name: Webhooks
    description: Manage webhook endpoints and events
  - name: Feedback
    description: Tell HeyGen how a generated result turned out
  - name: Account and usage
    description: Your account, the current API key, request logs and usage
paths:
  /v3/models/audio/voices:
    get:
      tags:
        - Voice
      summary: List Audio Voices
      description: >-
        Returns model-backed audio voices. With the default `type=private`,
        these are the voices in the caller's workspace, professional and
        instant, ordered newest first; `mode` tells them apart. With
        `type=public`, these are the voices HeyGen provides to every workspace,
        best first. Filter the public list with `language`, `gender` and `age`,
        or search it with `query`. A public page holds at most 50 voices. Use
        `limit` and `token` to retrieve additional pages. A token works only
        with the `type` and filters that returned it.
      operationId: listModelAudioVoices
      parameters:
        - name: type
          in: query
          required: false
          description: >-
            `private` lists the voices your workspace created. `public` lists
            the voices HeyGen provides to every workspace.
          schema:
            type: string
            enum:
              - private
              - public
            default: private
        - name: limit
          in: query
          required: false
          description: Maximum number of voices to return per page.
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
        - name: language
          in: query
          required: false
          description: >-
            Public list only. Language code, such as `en`. Matches voices whose
            native language is this language.
          schema:
            type: string
            minLength: 2
            maxLength: 8
        - name: gender
          in: query
          required: false
          description: Public list only. Voice gender.
          schema:
            enum:
              - male
              - female
            type: string
        - name: age
          in: query
          required: false
          description: Public list only. Voice age group.
          schema:
            type: string
            enum:
              - young
              - middle_aged
              - old
        - name: query
          in: query
          required: false
          description: >-
            Public list only. Free text matched against voice names and
            descriptions, such as `warm narrator`. Results are ordered by
            relevance.
          schema:
            maxLength: 256
            minLength: 1
            type: string
        - name: token
          in: query
          required: false
          description: Opaque pagination token returned by a previous request.
          schema:
            minLength: 1
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ModelAudioVoiceResponse'
                  has_more:
                    type: boolean
                    description: Whether more pages are available
                  next_token:
                    type:
                      - string
                      - 'null'
                    description: Opaque cursor for the next page
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: invalid_parameter
                  message: Invalid pagination token
                  param: token
                  doc_url: null
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: unauthorized
                  message: Invalid or expired API key. Verify your x-api-key header.
                  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:
    ModelAudioVoiceResponse:
      additionalProperties: false
      description: Customer-visible state of one model-backed audio voice.
      properties:
        voice_id:
          description: Stable identifier for this voice.
          title: Voice Id
          type: string
        mode:
          description: >-
            `professional` for a professional voice clone, `instant` for an
            instant voice clone.
          enum:
            - professional
            - instant
          title: Mode
          type: string
        name:
          description: Display name of the voice.
          title: Name
          type: string
        language:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            Primary language code of the voice. An instant clone created without
            one has none until its recording passes every check and the detected
            language is recorded, so a clone refused before that never gets one.
            A professional voice created without one has none until it is
            ACTIVE.
          title: Language
        gender:
          anyOf:
            - $ref: '#/components/schemas/ModelAudioVoiceGender'
            - type: 'null'
          default: null
          description: Voice gender. Present in the public list when known.
        status:
          $ref: '#/components/schemas/VideoTTSVoiceStatus'
          description: 'Current lifecycle state: `PENDING`, `ACTIVE`, or `FAILED`.'
        created_at:
          description: Unix timestamp in seconds when the voice was created.
          title: Created At
          type: integer
        failure_reason:
          anyOf:
            - $ref: '#/components/schemas/VideoTTSVoiceFailureReason'
            - type: 'null'
          default: null
          description: Stable failure code. Present only when `status` is `FAILED`.
        preview_audio_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            URL to a WAV clip of this voice reading a short fixed preview
            script: in its language when a script exists for it, otherwise in
            English. Present only when `status` is `ACTIVE` and a clip exists.
            The URL can expire; read the voice again rather than storing it.
          title: Preview Audio Url
      required:
        - voice_id
        - mode
        - name
        - status
        - created_at
      title: ModelAudioVoiceResponse
      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
        errors:
          type: array
          description: >-
            Per-item error details for batch/multi-node failures (e.g. graph
            compilation errors by node).
          items:
            $ref: '#/components/schemas/StandardAPIErrorDetail'
        request_id:
          type: string
          description: >-
            Request identifier, also returned in the X-HeyGen-Request-Id
            response header. Include it when contacting support.
          example: 8c4f0b9e1d2a4f6b9e3c7a1d5f2b8e40
      required:
        - code
        - message
    ModelAudioVoiceGender:
      description: Voice gender.
      enum:
        - male
        - female
      title: ModelAudioVoiceGender
      type: string
    VideoTTSVoiceStatus:
      description: Values persisted in ``video_tts_voices.status``.
      enum:
        - PENDING
        - ACTIVE
        - FAILED
      title: VideoTTSVoiceStatus
      type: string
    VideoTTSVoiceFailureReason:
      description: Stable failure codes persisted for terminal training failures.
      enum:
        - INVALID_AUDIO
        - INSUFFICIENT_AUDIO
        - PREPROCESSING_FAILED
        - TRAINING_FAILED
        - DESIGN_FAILED
        - ARTIFACT_VALIDATION_FAILED
        - INTERNAL_ERROR
      title: VideoTTSVoiceFailureReason
      type: string
    StandardAPIErrorDetail:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code
          example: unknown_node_type
        message:
          type: string
          description: Human-readable error message
          example: Unknown node type
        node_id:
          type: string
          description: Graph node id this error pertains to, if applicable
        port:
          type: string
          description: Port name on the node this error pertains to, if applicable
        path:
          type: string
          description: Field path within the item this error pertains to, if applicable
      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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.