How to create and manage tokens for API consumption in wolkvox
Table of Contents
To generate and manage authentication tokens, follow the steps below using the wolkvox Manager interface.
Process to Create a Token
To create a new token, you must access the integrations configuration within wolkvox Manager.
- Log in to wolkvox Manager.
- Click on the Configuration icon (gear), located in the top-right menu of the application.
- In the "Configuration" pop-up window, navigate and select the main Integrations tab.
- Within this section, click on the Tokens sub-tab.
- In the "Token Description" field, write a clear name or description that allows you to identify the token's use. This field is mandatory.
- Press the "Add Token" button.
- Immediately, the new token will be listed in the table below, showing the token itself, its description, the day's usage count, and the total consumption limit.

Managing Existing Tokens
Once tokens are created and listed in the table, you can easily manage them. Right-click on a specific token in the list to display the following options:
- Copy Token: Copies the alphanumeric value of the token to your clipboard. This is the recommended way to avoid transcription errors.
- Delete: Permanently deletes the selected token. This action cannot be undone.
- Refresh: Updates the list of tokens in the table. This is useful if you don't see a newly created token or if you want to update usage counters.
How to Use the wolkvox-token
To authenticate your API requests, you must send the generated token as a header in your HTTP request as follows:
- Header Name: wolkvox-token
- Header Value: [The token you copied from wolkvox Manager]
Token Consumption Limits and Considerations
Keep in mind that the same token cannot be consumed simultaneously without control across multiple processes. Therefore, it is recommended to schedule the consumption of the next API only when the result of the previous request has been successful.
- Limit of simultaneous consumption of a token: 2 simultaneous requests.
-
Daily token limit: Number of licenses multiplied by 1000 daily tokens.
- Daily token limit formula:
- Number of licenses * 1000 daily tokens
- Daily token limit formula:
- Daily token usage: 1000 per license.
This means that the available daily consumption will depend directly on the number of associated licenses.
Important Consideration: Server Maintenance
It is important to note that during maintenance processes, such as creating backups on the server, API consumption is temporarily disabled to ensure data integrity.
If you attempt to consume an API during this interval, you will receive the following response with a 403 Forbidden status code:
{
"code": "403",
"error": "Forbidden",
"msg": "The APIs cannot be consumed at this time, try again later."
}This is a controlled and expected response. Your development should be prepared to handle this scenario and retry the request later.