List voices (library or your clones)

GEThttps://server.heyrik.com/api/v1/voices

Headers

AuthorizationstringRequired

Use Bearer $HEYRIK_API_KEY with an account-scoped API key. Keep the key on your server.

Get your API key

Parameters 5

Fields documented for this operation. See the request example for placement and structure.

typestring

"all" (library voices, default) or "cloned" (only voices YOU cloned).

languagestring

Filter, e.g. en-IN, hi-IN.

genderstring

male | female.

pagenumber

Page number; walk with has_more.

limitnumber

Page size (default 24, max 100).

Response

Explore the example values. This is not a complete response schema.

dataobject

Explore 4 properties

countnumber

Example 42

pagenumber

Example 1

has_moreboolean

Example true

voicesarray

Explore 1 example item

[0]object

Explore 5 properties

idstring

Example "vx_9f2a1c30"

namestring

Example "Meera"

languagestring

Example "en-IN"

genderstring

Example "female"

clonedboolean

Example false

Error reference

GET/voices

cURL

# Library voices
curl "https://server.heyrik.com/api/v1/voices?language=en-IN" \
  -H "Authorization: Bearer $HEYRIK_API_KEY"

# Only your cloned voices
curl "https://server.heyrik.com/api/v1/voices?type=cloned" \
  -H "Authorization: Bearer $HEYRIK_API_KEY"

Response example

JSON

{
  "data": {
    "count": 42,
    "page": 1,
    "has_more": true,
    "voices": [
      {
        "id": "vx_9f2a1c30",
        "name": "Meera",
        "language": "en-IN",
        "gender": "female",
        "cloned": false
      }
    ]
  }
}

Illustrative examples · No live request is sent