Skip to main content
GET
/
v3
/
tts
curl -X GET "https://api.audixa.ai/v3/tts?generation_id=gen_abc123" \
  -H "x-api-key: YOUR_API_KEY"

{
  "generation_id": "gen_abc123",
  "status": "COMPLETED",
  "input_text": "Hello world",
  "voice_id": "am_ethan",
  "voice_name": "Ethan",
  "model": "base",
  "tokens": 12,
  "dollar_cost": 0.000012,
  "method": "API_WALLET",
  "audio_url": "https://cdn.audixa.ai/audio/gen_abc123.mp3",
  "created_at": "2024-03-20T10:00:00Z",
  "started_at": "2024-03-20T10:00:01Z",
  "completed_at": "2024-03-20T10:00:02Z"
}

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.

Poll this endpoint to check if your generation is complete. When status is COMPLETED, the audio_url field will contain the download link.
Endpoint
GET https://api.audixa.ai/v3/tts

​
Request

​
generation_id
string
required
The generation ID returned from POST /tts.

​
Response

​
generation_id
string
Unique identifier for the generation.
​
status
string
Current status: IN_QUEUE, GENERATING, COMPLETED, FAILED.
​
input_text
string
The input text that was submitted.
​
voice_id
string
Voice ID used.
​
voice_name
string
Human-readable voice name.
​
model
string
Model used: base or advanced.
​
tokens
integer
Number of tokens consumed.
​
dollar_cost
number
Final cost in USD.
​
method
string
Payment source: CREDITS_BALANCE (Monthly) or API_WALLET (Topup).
​
audio_url
string
Download URL for the audio file (only when status is COMPLETED).
​
error_message
string
Error details if status is FAILED.
​
created_at
string
ISO 8601 creation timestamp.
​
started_at
string
ISO 8601 timestamp when processing started.
​
completed_at
string
ISO 8601 timestamp when processing completed.
curl -X GET "https://api.audixa.ai/v3/tts?generation_id=gen_abc123" \
  -H "x-api-key: YOUR_API_KEY"

{
  "generation_id": "gen_abc123",
  "status": "COMPLETED",
  "input_text": "Hello world",
  "voice_id": "am_ethan",
  "voice_name": "Ethan",
  "model": "base",
  "tokens": 12,
  "dollar_cost": 0.000012,
  "method": "API_WALLET",
  "audio_url": "https://cdn.audixa.ai/audio/gen_abc123.mp3",
  "created_at": "2024-03-20T10:00:00Z",
  "started_at": "2024-03-20T10:00:01Z",
  "completed_at": "2024-03-20T10:00:02Z"
}

​
Polling Best Practices

Poll Interval

Poll every 1-2 seconds. Don’t poll faster than once per second.

Timeout

Set a maximum timeout (e.g., 60 seconds) to avoid infinite loops.

Error Handling

Always handle the FAILED status gracefully with retry logic.

Cache Results

Once completed, cache the audio_url to avoid re-polling.

​
Error Responses

Missing or invalid API key.
{
  "detail": "Invalid or missing API key"
}
Invalid or expired generation ID.
{
  "detail": "Generation not found"
}
Generation IDs expire 24 hours after creation.
Rate limit exceeded.
{
  "detail": "Rate limit exceeded. Please retry after 30 seconds."
}