Account Credits API
Narakeet provides an API endpoint for retrieving your available account credits. This is mostly useful for developers who integrate Narakeet into their own applications but pre-pay credits using a top-up plan, so they can check available credits and top-up before they run out of capacity.
This page explains how to use the account credits endpoint.
- API Endpoint
- Authenticating requests
- How to use the API to list available credits
- Result structure
- More information
The API endpoint that lists voices is available at
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
How to use the API to list available credits
To request a list of available voices:
- Use the
- Invoke the endpoint at
- Provide your API key in the
- Parse the response as JSON, and read the
creditSeconds result property contains the available credits for your account, measured in seconds.
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/account/credits
The response is a JSON object, containing elements with the following properties
creditSeconds: integer, the quantity of credit seconds still available for your account to create audio/video materials
requestId: string, internal request ID of your API call
identity: string, the ID of this API access key - you will need this if you want to contact us about any billing queries
billingId: string the id of this billing plan - you will need this if you want to contact us about any billing queries
plan: string, the billing plan type this account is associated with (for top-up accounts, it will be “TOPUP”).
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.
- For general API limitations and pricing, see the main Developer API page.