Voice Listing API
Narakeet provides an API endpoint for retrieving an up-to-date list of available voices. This is useful for developers that want to integrate Narakeet voices into their own content management systems or applications, and allow end-users to choose a voice for text to speech conversion. This page explains how to use the voice listing endpoint.
- API Endpoint
- Authenticating requests
- How to use the API to list available voices
- Result structure
- How frequently to call this endpoint
- Pricing
- More information
API Endpoint
The API endpoint that lists voices is available at https://api.narakeet.com/voices
Authenticating requests
To use the API, you will need a Narakeet API key. For information on how to get a key, check out our guide on Managing API Keys.
You should provide the API key as a header to all requests to the public REST endpoints, using the x-api-key
header.
How to use the API to list available voices
To request a list of available voices:
- Use the
GET
HTTP method - Invoke the endpoint at
https://api.narakeet.com/voices
- Provide your API key in the
x-api-key
header
CURL example
To execute the API call from a command line using CURL, use the following command (and set the $NARAKEET_API_KEY environment variable, or replace that in the call with your API key):
curl -X GET -H "x-api-key: $NARAKEET_API_KEY" https://api.narakeet.com/voices
Result structure
The response is a JSON array, containing elements with the following properties
name
: The voice name, that you can use with our Text to Speech API AI voice generators.language
: User-friendly name of the language and dialect (for example, “English (American)”).languageCode
: locale language code (for example en-US).styles
: a JSON array of supported narration styles for the voice
How frequently to call this endpoint
We recommend caching the result of this API call locally, and not invoking it more than once per day - the voices do not change very frequently.
Pricing
There is no cost to use this endpoint, since you are not building any content with it. However, using the endpoint counts towards your maximum call limit per day.
More information
- See this flow in action, implemented using Node.js, in the narakeet/api-client GitHub project.
- For general API limitations and pricing, see the main Developer API page.