Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.audixa.ai/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you through generating speech with the Audixa API, from creating your account to downloading your first audio file.

​
Step 1: Get Your API Key

1

Create an Account

Sign up for a free Audixa account. New accounts receive 10,000 free credits.
2

Generate API Key

Navigate to Dashboard → API Keys and create a new API key.
3

Copy Your Key

Copy your API key and store it securely. You’ll need it for all API requests.
Keep your API key secret. Never expose it in client-side code or public repositories.

​
Step 2: Install the SDK

pip install audixa

​
Step 3: Generate Your First Audio

The simplest way to generate audio is using the convenience methods that handle the entire async workflow for you: 
import audixa

# Set your API key (or use AUDIXA_API_KEY env variable)
audixa.set_api_key("YOUR_API_KEY")

# Generate TTS and get audio URL
audio_url = audixa.tts_and_wait(
    "Hello! Welcome to Audixa, the best text-to-speech API.",
    voice_id="am_ethan",
)
print(f"Audio URL: {audio_url}")

# Or save directly to file
audixa.tts_to_file(
    "Hello! Welcome to Audixa.",
    "output.wav",
    voice_id="am_ethan",
)

{
  "status": "Completed",
  "audio_url": "https://cdn.audixa.ai/audio/gen_abc123xyz789.wav"
}

​
Using Advanced Features

import audixa

audixa.set_api_key("YOUR_API_KEY")

# Base model with speed adjustment
audio_url = audixa.tts_and_wait(
    "Welcome to Audixa AI, your text-to-speech solution.",
    voice_id="am_ethan",
    model="base",
    speed=1.1,  # Slightly faster (0.5 to 2.0)
)

# Advanced model with expressiveness controls
audio_url = audixa.tts_and_wait(
    "This is exciting news! We have launched.",
    voice_id="am_ethan",
    model="advanced",
    cfg_weight=3.5,       # Controls how strictly the model follows the style (1.0-5.0)
    exaggeration=0.7,     # Controls emotional expressiveness (0.0-1.0)
    audio_format="mp3",   # Output format: "wav" or "mp3"
)

​
Next Steps

Python SDK

Full SDK documentation with async support and error handling.

Node.js SDK

TypeScript SDK with full type definitions.

Explore Voices

Browse the voice library to find the perfect voice for your project.

API Reference

Learn about all available parameters and options.