Quickstart
The app is in Italian: its labels are written here as you see them. In five minutes you go from an API key to the first response of the v1 public API. You need an Owner or an Admin of the Organization and a plan that includes the public API.
1. Create a key
- Sign in to the app as an Owner or an Admin.
- Open Sviluppatori (Developers), then Accesso (Access).
- Create a new key: choose a name, the environment and the scopes.
- Copy the key right away. It is shown only once and cannot be recovered: if you lose it, create a new one or rotate it.
For this guide you need:
- the test environment (
vx_test_…), or the live one (vx_live_…); - the
calls:readscope (Read calls).
A test key reads the Organization’s real data but never writes: writes are simulated, call nobody and cost nothing. It is the safest way to start.
If the public API is not included in the plan, every request with a valid key gets 403 feature_not_available.
2. Check the key
GET /v1/me answers to any valid key and shows its scopes, expiry and request limits.
The response looks like this:
If you get 401 invalid_api_key, check that you copied the whole key. See Authentication.
3. Read the latest calls
GET /v1/calls returns the Organization’s calls, most recent first. Here we ask for the last five.
Each item of data is a call:
report_card is the call’s Report card. If has_more is true, pass next_cursor as cursor to read the next page: see Pagination.
4. What to look at in the responses
X-Request-Id: the id of the request. Quote it when you write to support.RateLimit-Limit,RateLimit-Remaining,RateLimit-Reset: the requests you have left.VoxAI-Version: the API version used. Today only2026-10-01exists.
Next steps
- Authentication: scopes, rotation and revocation of keys.
- Idempotency: how to safely repeat requests that write.
- Errors: the shape of error responses and every code.
- Webhooks: receive events instead of polling the API.
- The API Reference describes every route, with parameters and responses.