v1

latestOpenAPI 3.0.1MIT2026-07-26104203277.0 KB

List TTS voices

Retrieve available TTS voices with optional filtering, pagination, and source flags.

get/v2/tts/voices

Query parameters

qstring
Example:test

Search query string.

pageinteger required
Example:1

Current page number.

perPageinteger required
Example:10

Number of voices per page.

source'jobs' | 'voice_agents' required
Example:voice_agents

Filter voices by source. jobs for media voices, voice_agents for agents voices.

recentlyUsedboolean
Example:true

Filter by recently used flag.

allboolean

Return all voices when true.

myVoicesboolean
Example:true

Filter by voices owned by the user.

favouriteboolean
Example:true

Filter favourite voices.

genderstring[]

Filter by one or more genders.

[
  "male",
  "female"
]
languagestring[]

Filter by one or more languages.

[
  "ar",
  "en"
]
stylestring[]

Filter by one or more styles.

[
  "narrator",
  "conversational"
]
dialectIdstring[]

Filter by one or more dialect IDs (UUID).

[
  "ae6d58c6-c6bd-4ae0-ad74-b8b39c29928b",
  "2b9d0f7e-6c1b-4a41-9e41-3a7e6f5d9a11"
]
projectIdstring required
Example:ae6d58c6-c6bd-4ae0-ad74-b8b39c29928b

Project identifier.

Response

Voices retrieved successfully.

successboolean
messagestring
messageKeystring

Example response

{
  "success": true,
  "message": "Operation completed successfully",
  "messageKey": "OPERATION_SUCCESSFUL",
  "data": {
    "voices": [
      {
        "id": "633f19a6-089b-4950-bfab-55f5c750732e",
        "language": "ar",
        "name": "Aisha",
        "tags": [
          "female",
          "conversational"
        ],
        "voiceRecord": "https://cdn.tryhamsa.com/tts-voices/Aisha.wav",
        "dialectId": "6ac0324d-bcb9-40f3-a57a-de6da7b721c8",
        "dialect": {
          "name": "Oman",
          "languageCode": "oma"
        },
        "image": "https://cdn.tryhamsa.com/tts-voices-images/aisha.jpg",
        "createdAt": "2025-12-18T11:21:36.182Z",
        "usedInJobs": true,
        "usedInVoiceAgents": true
      }
    ],
    "totalPages": 5,
    "page": 1,
    "totalCount": 50
  }
}