Before sending requests to Voiceform API you need to generate an API Access Token.
Creating API Access Token
- Open Voiceform App and log in to your account https://app.voiceform.com
- Go to account page and scroll to the "API Tokens" section at the bottom. Note: if you don't see the section you should upgrade your account to Pro Plan or contact Voiceform Customer Support service for API access
- Click on "Create API token" and specify its name. Click"Create"
- After that, copy the token and store it somewhere safe. Note that after closing the module you won't be able to see the token again.
The number of tokens is limited to 25 tokens per user
Authorization
Specify the generated token as an "Authorization" header with Bearer token
Here is an example:
curl --location --request POST 'https://app.voiceform.com/api/v1/results' \
--header 'Authorization: Bearer 2|YD5OXdW2z456SHGDVHvxsjXgFNt6NnJx7utHdmQ' \
--header 'Content-Type: application/json' \Rate Limit
To ensure fair usage and protect our infrastructure, API access is rate limited. The default rate limits are as follows:
| Per Minute | 120 requests per minute | Per user (or IP if unauthenticated) |
| Per Day | 2000 requests per day | Per user (or IP if unauthenticated) |
Rate-limit status is returned as HTTP response headers on every API response. These values are not included in the JSON body.
| Header | Present on | Description |
|---|---|---|
X-RateLimit-Limit | All responses | Maximum number of requests allowed in the current window |
X-RateLimit-Remaining | All responses | Number of requests remaining in the current window |
Retry-After | HTTP 429 responses | Seconds to wait before retrying |
X-RateLimit-Reset | HTTP 429 responses | Unix timestamp (seconds) when the current window resets |
If you exceed a limit, the API returns HTTP 429 Too Many Requests with a JSON body such as:
{
"message": "Too Many Attempts."
}Use X-RateLimit-Remaining to throttle requests before you hit the cap. After a 429, wait for the number of seconds in Retry-After before sending another request.