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.

Welcome to the Audixa API Reference. This section provides detailed documentation for all API endpoints.

​
Base URL

All API requests are made to: 
https://api.audixa.ai/v3

​
Authentication

All endpoints require authentication via the x-api-key header: 
-H "x-api-key: YOUR_API_KEY"

Learn More

See the Authentication guide for details on obtaining and using API keys.

​
Official SDKs

We interpret your request using our official open-source SDKs for Python and Node.js:

Python SDK

pip install audixa

Node.js SDK

npm install audixa

​
Async Workflow

Audixa uses an asynchronous workflow for audio generation:
1

Submit TTS Request

POST to /v3/tts with your text, voice, and model. Receive a generation_id and initial status IN_QUEUE.
2

Poll Status

GET /v3/tts with your generation_id until status is COMPLETED.
3

Download Audio

Fetch the audio file from the returned audio_url.

​
Available Endpoints

POST /tts

Start a text-to-speech generation job.

GET /tts (Status)

Check the status of a generation job.

GET /voices

List available voices for a model.

GET /history

Retrieve generation history.

WS /stream

Real-time audio streaming.

​
Response Format

All responses are JSON. Successful responses return status 2xx with the requested data. Success example: 
{
  "generation_id": "gen_abc123xyz789"
}
Error example: 
{
  "detail": "Error message explaining what went wrong"
}

Quickstart

Get your first audio in 5 minutes.

Error Codes

Understand and handle API errors.

Rate Limits

Learn about request limits and best practices.

Pricing

Understand credit-based billing.