Account and API key

You need an account, a workspace and a key. It takes a few minutes. A new account starts with $1 in its balance, to try it.

Create an account

1. Go to voxoria.ai/register.
2. Enter your full name, work email and a password of at least 8 characters.
3. Open the verification link we email you.

Create a workspace

After you verify, the console asks for a workspace name. A workspace owns your members, API keys and calls. Billing stays with the account. See Workspaces.

An account holds one workspace.

Create an API key

Keys belong to the workspace. One set serves all of it.

1. Open API keys in the sidebar.
2. Click Create key.
3. Give it a label. Name it after what will hold it.
4. Choose a scope: All endpoints or Read only. A read-only key is refused by every endpoint that writes.
5. Copy the secret. It is shown once.

Creating keys needs the admin or owner role. See Team and roles.

Check the key

GET /v1/ping confirms the key authenticates and returns the workspace it acts for.

curl https://api.voxoria.ai/v1/ping \
  -H "Authorization: Bearer $VOXORIA_API_KEY"

{ "organization_id": "..." }

The API calls a workspace an organization. They are the same thing.

Rotate or revoke a key

Both actions are on the API keys page.

• Rotate gives the key a new secret. The previous one stops working immediately.
• Revoke retires the key. A revoked key cannot be restored.

Next

Connect an agent.