> ## 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 the model-backed audio voices in the caller's workspace, ordered newest first. Use `limit` and `token` to retrieve additional pages.



## 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 Agent
    description: Create videos from text prompts using AI
  - name: Videos
    description: Create, list, retrieve, and delete videos
  - name: Templates
    description: Generate videos from reusable templates by replacing their variables
  - 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: AI Clipping
    description: Turn long-form videos into ready-to-share short clips with captions
  - name: Batches
    description: Create and track batches of videos.
  - name: Video Translation Batches
    description: Create and track batches of video translations.
  - name: Lipsync Batches
    description: Create and track batches of lipsyncs.
  - name: Asset Batches
    description: Create and track batches of direct-to-S3 asset uploads.
  - name: User
    description: Account information and billing
  - name: API Keys
    description: Inspect the API key authenticating the current request
  - 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)
  - name: HyperFrames
    description: Render HyperFrames composition zips into video — separate from /v3/videos
  - name: Models
    description: ''
  - name: Filler Word Removal
    description: ''
paths:
  /v3/models/audio/voices:
    get:
      tags:
        - Models
      summary: List Audio Voices
      description: >-
        Returns the model-backed audio voices in the caller's workspace, ordered
        newest first. Use `limit` and `token` to retrieve additional pages.
      operationId: listModelAudioVoices
      parameters:
        - 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: 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
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: forbidden
                  message: >-
                    The professional voice cloning API is not enabled for this
                    account.
                  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:
          $ref: '#/components/schemas/ModelAudioVoiceMode'
          description: Voice creation mode.
        name:
          description: Display name of the voice.
          title: Name
          type: string
        language:
          description: Primary language code supplied when the voice was created.
          title: Language
          type: string
        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`.
      required:
        - voice_id
        - mode
        - name
        - language
        - 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'
      required:
        - code
        - message
    ModelAudioVoiceMode:
      description: Supported audio-voice creation implementations.
      enum:
        - professional
      title: ModelAudioVoiceMode
      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.

````