Voices Endpoint

Voices Endpoint

This page details the Voices API Endpoint, which provides a list of available voices for text-to-speech conversion.


Endpoint Details

GET /voices/list

Retrieves a list of available voices that can be used for text-to-speech conversion.


Authentication

This endpoint requires an API key for access. Include your API key in the request headers:

sh
Authorization: Bearer YOUR_API_KEY

If a valid API key is not provided, the request will return a 401 Unauthorized error.


Example Request

sh
curl -X GET "https://api.suonora.com/v1/voices/list" \
     -H "Authorization: Bearer YOUR_API_KEY"

Example Response

json
{
  "success": true,
  "voices": [
    {
      "id": "axel",
      "name": "Axel",
      "gender": "Male",
      "locale": "de-DE",
      "mp3_preview": "https://storage.googleapis.com/suonora-public/voices/Axel.mp3"
    }
  ]
}

Response Codes

HTTP StatusDescription
200Request was successful.
401Unauthorized – API key is missing or invalid.
403Forbidden – The API key does not have permission to access this resource.
429Too Many Requests – The request rate limit has been exceeded.
500Internal Server Error – An unexpected error occurred on the server.

Ensure you have a valid API key and the correct permissions before making requests to this endpoint.