Catalog

Preview a voice

GEThttps://voxa.abhinavyadav.in/api/v1/voices/{voice_id}/preview

Speaks text with the voice and returns MP3 audio.

Authorization

An API key (X-API-Key or Authorization: Bearer), or a signed-in member with the agents.view permission.

X-API-KeyAuthorization: Beareragents.view

Path parameters

voice_idstringrequired

The voice's id.

Query parameters

textstring

What to say.

at most 300 characters

modelstringdefault: "sonic-3.6"

The text-to-speech model.

at most 40 characters

languagestringdefault: "hi"

The language of text.

at most 10 characters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Response

200Success.

The file itself (audio/mpeg).

401No credentials, or they are invalid or revoked.

detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.

detailstring

What went wrong, in plain words.

422Validation Error

detailobject[]

Show item attributes

locstring | integer[]

msgstring

typestring

429Over the per-key rate limit; wait for Retry-After.

detailstring

What went wrong, in plain words.

curl --request GET \
  --url 'https://voxa.abhinavyadav.in/api/v1/voices/{voice_id}/preview?timezone=Asia/Kolkata' \
  --header 'X-API-Key: <api-key>' \
  --output response.mp3

import requests

url = "https://voxa.abhinavyadav.in/api/v1/voices/{voice_id}/preview"
params = {
    "timezone": "Asia/Kolkata",
}
headers = {
    "X-API-Key": "<api-key>",
}

response = requests.get(url, params=params, headers=headers)
response.raise_for_status()
with open("response.mp3", "wb") as f:
    f.write(response.content)

const response = await fetch("https://voxa.abhinavyadav.in/api/v1/voices/{voice_id}/preview?timezone=Asia/Kolkata", {
  headers: {
    "X-API-Key": "<api-key>",
  },
})
const file = await response.blob()

Response

A file (audio/mpeg).

{
  "detail": "sign in required"
}

{
  "detail": "your role cannot do this (agents.view)"
}

{
  "detail": [
    {
      "type": "missing",
      "loc": [
        "body",
        "name"
      ],
      "msg": "Field required",
      "input": {}
    }
  ]
}

{
  "detail": "rate limit exceeded; slow down"
}