List voices

Retrieve available voices for agent configuration.

Supports filtering by language, free-text search on the voice name, sorting, and pagination. Voices are scoped to active entries by default.

GET /voices

List voices

cURL

curl --request GET \
  --url https://api.omnia-voice.com/api/v1/voices \
  --header 'X-API-Key: <api-key>'

200

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "previewUrl": "<string>",
      "languageCode": "<string>",
      "gender": "<string>",
      "isActive": true,
      "language": {
        "code": "<string>",
        "name": "<string>"
      }
    }
  ],
  "groupedByLanguage": {},
  "total": 123,
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123,
    "returned": 123
  }
}

Authorizations

X-API-Key · string · header · required

API key for authentication

Query Parameters

languageCode · string

Filter by exact language code, e.g. en, en-GB, pt-BR. Use GET /languages to discover valid codes.

isActive · boolean

Filter by active status. Defaults to true when omitted.

search · string

Case-insensitive substring match on the voice name.

sortBy · enum<string> · default: languageCode

Field to sort results by.

Available options: name, languageCode

sortDir · enum<string> · default: asc

Sort direction.

Available options: asc, desc

limit · integer · default: 100

Maximum number of voices to return.

Required range: 1 <= x <= 200

offset · integer · default: 0

Number of voices to skip (for pagination).

Required range: x >= 0

Response

200 - application/json

Successful response

data · object[]

Show child attributes

groupedByLanguage · object

Convenience grouping of the returned page by languageCode. Each entry contains a subset of Voice fields suitable for rendering grouped pickers.

Show child attributes

total · integer

Total number of voices matching the filters (unpaged).

pagination · object

Show child attributes