Skip to main content
All Audixa API requests require authentication using an API key. This guide explains how to obtain and use your API key.

Getting Your API Key

1

Log In

Sign in to your Audixa Dashboard.
2

Navigate to API Keys

3

Create a Key

Click Create New Key, give it a name (e.g., “Production” or “Development”), and copy the generated key.
Your API key is shown only once. Store it securely immediately after creation.

Using Your API Key

Include your API key in the x-api-key header with every request:
curl -X POST "https://api.audixa.ai/v2/tts" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{"text": "Hello world", "voice": "aura-asteria-en", "model": "base"}'

Security Best Practices

Keep Keys Secret

Never expose API keys in client-side code, public repos, or logs.

Use Environment Variables

Store keys in environment variables, not in source code.

Rotate Regularly

Rotate keys periodically and immediately if compromised.

Use Separate Keys

Use different keys for development and production environments.

Authentication Errors

If authentication fails, the API returns a 401 Unauthorized error:
{
  "detail": "Invalid or missing API key"
}
Common causes:
  • Missing x-api-key header
  • Invalid or revoked API key
  • Key copied incorrectly (extra spaces, partial copy)

Managing API Keys

In the dashboard, you can:
  • View keys: See all active keys (only the last 4 characters are shown for security)
  • Revoke keys: Immediately disable compromised or unused keys
  • Create new keys: Generate additional keys for different use cases
There’s no limit on the number of API keys you can create.