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

# Voice Catalog

> Returns every voice you can use by ID: Hamsa's published voices and your own cloned voices, sorted by name. The list is at the top level (`voices`), not in the usual `data` envelope, so TTS connectors such as Genesys can read it directly.



## OpenAPI

````yaml /api-reference/openapi.json get /v2/tts/voices/catalog
openapi: 3.0.1
info:
  title: Hamsa API
  description: >-
    The Hamsa API: voice agents and their calls, phone numbers, batch calls and
    knowledge bases; speech to text, text to speech, voices and AI content.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.tryhamsa.com
security: []
paths:
  /v2/tts/voices/catalog:
    get:
      summary: List the voice catalog
      description: >-
        Returns every voice you can use by ID: Hamsa's published voices and your
        own cloned voices, sorted by name. The list is at the top level
        (`voices`), not in the usual `data` envelope, so TTS connectors such as
        Genesys can read it directly.
      parameters:
        - in: query
          name: language
          required: false
          description: >-
            Only voices of this language: a BCP-47 tag (`ar-SA`) or a Hamsa
            dialect code (`ksa`). Codes: `pls` ar-PS, `egy` ar-EG, `syr` ar-SY,
            `irq` ar-IQ, `jor` ar-JO, `leb` ar-LB, `ksa` ar-SA, `uae` ar-AE,
            `bah` ar-BH, `qat` ar-QA, `kuw` ar-KW, `oma` ar-OM, `msa` ar, `en`
            en-US.
          schema:
            type: string
            minLength: 1
            example: ar-PS
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  voices:
                    type: array
                    items:
                      $ref: '#/components/schemas/TtsVoiceCatalogVoice'
                    example:
                      - id: bf1f8b18-bb5d-40b6-a46b-89274ea800a2
                        name: Amanda
                        language: en-US
                        gender: female
                      - id: 078338c4-7788-4371-95d4-1bbe45021113
                        name: Amjad
                        language: ar-PS
                        gender: male
        '400':
          description: Invalid query parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '401':
          description: 'Unauthorized: missing or invalid API key.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '500':
          description: Server Side Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    TtsVoiceCatalogVoice:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Voice ID.
          example: 078338c4-7788-4371-95d4-1bbe45021113
        name:
          type: string
          description: Voice name.
          example: Amjad
        language:
          type: string
          enum:
            - ar-PS
            - ar-EG
            - ar-SY
            - ar-IQ
            - ar-JO
            - ar-LB
            - ar-SA
            - ar-AE
            - ar-BH
            - ar-QA
            - ar-KW
            - ar-OM
            - ar
            - en-US
          description: >-
            BCP-47 language tag of the voice's dialect (`ar` for Modern Standard
            Arabic).
          example: ar-PS
        gender:
          type: string
          nullable: true
          enum:
            - male
            - female
          description: '`null` when the voice has no gender tag.'
          example: male
    ErrorSchema:
      type: object
      properties:
        code:
          type: integer
          description: >-
            Service error code: the HTTP status with a service prefix (for
            example `8404`). Missing when the service has no code for that
            status.
          example: 8404
        message:
          type: string
          description: >-
            What went wrong. Some services (calls and recordings) put the error
            key here, for example `CallNotFoundOrUnavailable`, and send no
            `messageKey`.
          example: Policy not found!
        messageKey:
          type: string
          description: >-
            Stable key for the error, safe to match on in code. Not returned by
            every service.
          example: PolicyNotFound
        params:
          type: object
          additionalProperties: true
          description: >-
            Details for some errors (for example `reason`). Not returned by
            every service.
          example:
            reason: NO_DRAFT
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Pass the API key in the Authorization header, You need to put Token
        keyword before the API key. e.g. 'Authorization: Token <api-key>'

````

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