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

# List voice models

> Returns voice models available to the authenticated client. By default the response includes both Audimee's built-in voices and the client's own custom voices. Use the `type` query parameter to narrow the response.

Responses are returned in this order: Audimee voices first, then custom voices.



## OpenAPI

````yaml GET /voice-models
openapi: 3.1.0
info:
  title: Audimee API
  description: >-
    The Audimee API lets clients browse voice models, train custom voices, and
    run AI voice conversions.
  version: 1.0.0
servers:
  - url: https://audimee.com/api/v1
security:
  - bearerAuth: []
paths:
  /voice-models:
    get:
      tags:
        - Voice Models
      summary: List voice models
      description: >-
        Returns voice models available to the authenticated client. By default
        the response includes both Audimee's built-in voices and the client's
        own custom voices. Use the `type` query parameter to narrow the
        response.


        Responses are returned in this order: Audimee voices first, then custom
        voices.
      operationId: listVoiceModels
      parameters:
        - name: type
          in: query
          required: false
          description: Filter the response by voice model type. Omit to return both.
          schema:
            type: string
            enum:
              - audimee
              - custom
      responses:
        '200':
          description: Voice models, ordered Audimee voices first, then custom voices.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/VoiceModel'
              example:
                - id: '101'
                  type: audimee
                  name: Mark
                  description: >-
                    Meet Mark, the AI singer whose electrifying voice
                    effortlessly navigates the realms of Pop and EDM,
                    captivating audiences with a unique blend of airy vocals
                    that soar across a wide range.
                  previewUrl: >-
                    https://public-assets.audimeestorage.com/artistPreviews%2Fmark-preview.mp3
                  gender: Male
                  genres:
                    - Pop
                    - Dance
                    - Airy
                  pitchLow: C3
                  pitchHigh: C5
                - id: 8f1c2a7e-3d0b-4b2a-9f6a-1f4d6c3e9b21
                  type: custom
                  name: My band lead
                  createdAt: '2026-04-12T14:08:21.000Z'
                  percentageDone: 100
                  confirmedDone: true
                  failed: false
                  failedMessage: null
        '400':
          description: Invalid `type` filter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Invalid 'type' filter. Must be 'audimee' or 'custom'.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          description: Server error while fetching custom voice models.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Server error fetching custom voice models
components:
  schemas:
    VoiceModel:
      description: >-
        Discriminated by `type`. `audimee` is a built-in voice; `custom` is a
        client-trained voice.
      oneOf:
        - $ref: '#/components/schemas/AudimeeVoiceModel'
        - $ref: '#/components/schemas/CustomVoiceModel'
      discriminator:
        propertyName: type
        mapping:
          audimee:
            $ref: '#/components/schemas/AudimeeVoiceModel'
          custom:
            $ref: '#/components/schemas/CustomVoiceModel'
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable explanation of what went wrong.
    AudimeeVoiceModel:
      type: object
      required:
        - id
        - type
        - name
        - description
        - previewUrl
        - gender
        - genres
        - pitchLow
        - pitchHigh
      properties:
        id:
          type: string
          description: Short numeric string identifying the built-in voice (e.g. `"101"`).
        type:
          type: string
          enum:
            - audimee
          description: Always `audimee` for built-in voices.
        name:
          type: string
          description: Display name of the voice.
        description:
          type: string
          description: Marketing description of the voice and its characteristics.
        previewUrl:
          type: string
          description: Public URL to a short preview clip of the voice.
        gender:
          type: string
          enum:
            - Male
            - Female
          description: Voice gender.
        genres:
          type: array
          items:
            type: string
          description: Genres this voice is suitable for.
        pitchLow:
          type: string
          description: >-
            Low end of the voice's core pitch range, as a note name string (e.g.
            `C3`, `F#3`).
        pitchHigh:
          type: string
          description: >-
            High end of the voice's core pitch range, as a note name string
            (e.g. `C5`, `G#4`).
    CustomVoiceModel:
      type: object
      required:
        - id
        - type
        - name
        - createdAt
        - percentageDone
        - confirmedDone
        - failed
        - failedMessage
      properties:
        id:
          type: string
          format: uuid
          description: UUID of the custom voice model.
        type:
          type: string
          enum:
            - custom
          description: Always `custom` for client-trained voices.
        name:
          type: string
          description: Name the client supplied when creating the model.
        createdAt:
          type: string
          format: date-time
          description: ISO 8601 timestamp when the model was created.
        percentageDone:
          type: number
          minimum: 0
          maximum: 100
          description: Training progress, `0`–`100`. Reaches `100` when training finishes.
        confirmedDone:
          type: boolean
          description: >-
            `true` once training finishes successfully and the model is usable
            for conversions.
        failed:
          type: boolean
          description: >-
            `true` if training failed. The model cannot be used for conversions
            in this state.
        failedMessage:
          type:
            - string
            - 'null'
          description: >-
            Failure reason when `failed` is `true`; `null` otherwise. Always
            present.
  responses:
    Unauthorized:
      description: Missing, malformed, or unrecognised bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingHeader:
              summary: No Authorization header
              value:
                error: Missing or invalid Authorization header
            invalidToken:
              summary: Token not recognised
              value:
                error: Invalid authorization token
            userNotFound:
              summary: Token valid but user no longer exists
              value:
                error: User not found
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Static API key issued by Audimee, passed as `Authorization: Bearer
        {token}`.

````