API Documentation

Kubatanidza TTS.ai mumaapplication ako neiyo REST API. OpenAI-inowirirana fomati yekufambisa nyore.

REST API OpenAI inowirirana JSON Mibvunzo Streaming rutsigiro

Kuongorora

The TTS.ai API provides programmatic access to all platform features: text-to-speech synthesis, speech-to-text transcription, voice cloning, audio enhancement, and more. The API uses standard REST conventions with JSON request/response bodies.

API Key

Tora yako API kiyi kubva Zvirongwa zveAccount. Available on Pro uye Enterprise zvirongwa.

Base URL

https://api.tts.ai/v1/

Authentication

Bearer token via Authorization peji repamusoro

Authentication

All API zvikumbiro zvinoda authentication kuburikidza a Bearer token mu Authorization peji repamusoro.

HTTP Header
Authorization: Bearer sk-tts-your-api-key-here
Keep your API key secret. Do not share it in client-side code, public repositories, or logs. Rotate keys regularly from your account settings.

Base URL

Base URL: https://api.tts.ai/v1/

All endpoints are relative to this base URL. For example, the TTS endpoint is:

POST https://api.tts.ai/v1/tts/

Zvirambidzo zvemutengo

API rate limits zvinosiyana nechirongwa:

Plan Zvikumbiro/min Concurrent Max Text Length
Pro 60 5 5,000 chars
Enterprise 300 20 50,000 chars

Rate limit headers zvinosanganisirwa mune yega yega mhinduro: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

Mitengo yechikwereti

Service Mutengo Unit
TTS (Free mamodheru: Piper, VITS, MeloTTS) 1 credit per 1,000 characters
TTS (Standard mamodheru: Kokoro, CosyVoice 2, etc.) 2 credits per 1,000 characters
TTS (Premium mamodheru: Tortoise, Chatterbox, etc.) 4 credits per 1,000 characters
Kutaura-Ku-TekisiName 2 credits per minute of audio
Voice Cloning 4 credits per 1,000 characters
Voice ChangerName 3 credits per minute of audio
Kuvandudzwa kweSound 2 credits per minute of audio
Vocal Kubvisa / Stem Splitting 3-4 zvikwereti per minute of audio
Kushandura Kutaura 5 credits per minute of audio
Kutaura nezwi 3 credits per turn
Key & BPM Finder Vakasununguka --
Audio Converter Vakasununguka --

Text to SpeechName

POST /v1/tts/

Kushandura tebhu kuita mashoko emitauro. Inodzosera faira remitauro mufomati yaunoda.

Kukumbira muviri

Parameter_Ruvara:InodiwaKutaura
model string _Hapana Model ID (e.g., kokoro, chatterbox, piper)
text string _Hapana Text to convert to speech (max 5,000 chars for Pro, 50,000 for Enterprise)
voice string _Hapana Voice ID (use /v1/voices/ to list available voices)
format string Hapana Output format: mp3 (yakajairika), wav, flac, ogg
speed float Hapana Muenzaniso wesimba rekutaura. Zviri pachena: 1.0. Rangarira: 0.5 kusvika 2.0
language string Hapana Kodhi yechitauro (e.g., en, es). Inoonekwa otomatiki kana yakadzimwa.
stream boolean Hapana Inoita kuti kufona kuendeswe. Zviri pachena: false

Muenzaniso wechikumbiro

cURL
curl -X POST https://api.tts.ai/v1/tts/ \
  -H "Authorization: Bearer sk-tts-your-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "kokoro",
    "text": "Hello from TTS.ai! This is a test.",
    "voice": "af_bella",
    "format": "mp3"
  }' \
  --output output.mp3

Kubvunzana

Returns the audio file as binary data with appropriate Content-Type header (audio/mpeg, audio/wav, etc.).

Kubvunzana
Content-Type: audio/mpeg
Content-Length: 48256
X-Credits-Used: 2
X-Credits-Remaining: 498

Kutaura-Ku-TekisiName

POST /v1/stt/

Transcribe audio to text. Supports 99 languages with auto-detection.

Kukumbira muviri (multipart/form-data)

Parameter_Ruvara:InodiwaKutaura
file file _Hapana Audio faira (MP3, WAV, FLAC, OGG, M4A, MP4, WebM). Max 100MB.
model string Hapana STT model: whisper (default), faster-whisper, sensevoice
language string Hapana Kodhi yechitauro. auto yekuwana otomatiki (yakajairika).
timestamps boolean Hapana Kusanganisira timestamps paword-level. Default: false
diarize boolean Hapana Kuita kuti mutauro uite diarization. Zviri pachena: false

Kubvunzana

JSON mhinduro
{
  "text": "Hello, this is a transcription test.",
  "language": "en",
  "duration": 3.5,
  "segments": [
    {
      "start": 0.0,
      "end": 1.8,
      "text": "Hello, this is",
      "speaker": "SPEAKER_00"
    },
    {
      "start": 1.8,
      "end": 3.5,
      "text": "a transcription test.",
      "speaker": "SPEAKER_00"
    }
  ]
}

Voice Cloning

POST /v1/tts/clone/

Create speech in a cloned voice. Upload a reference audio and text.

Kukumbira muviri (multipart/form-data)

Parameter_Ruvara:InodiwaKutaura
reference_audio file _Hapana Reference voice audio (10-30 masekondi anokurudzira). Max 20MB.
text string _Hapana Text to speak in the cloned voice.
model string Hapana Clone model: chatterbox (default), cosyvoice2, gpt-sovits
format string Hapana Output format: mp3 (default), wav, flac
language string Hapana Nhamba yechinangwa chemitauro. Inofanira kutsigirwa nechigadzirwa chakasarudzwa.

Kubvunzana

Inodzosera audio faira se binary data, imwechete se TTS endpoint.

Voice ChangerName

POST /v1/voice-convert/

Convert audio to sound like a different voice. Upload source audio and choose a target voice.

Kukumbira muviri (multipart/form-data)

Parameter_Ruvara:InodiwaKutaura
file file _Hapana Source audio file (MP3, WAV, FLAC). Max 50MB.
target_voice string _Hapana Target voice ID to convert to (use /v1/voices/ to list available voices)
model string Hapana Mufananidzo wekushandurwa kwezwi: openvoice (yakajairika), knn-vc
format string Hapana Output format: wav (default), mp3, flac

Muenzaniso wechikumbiro

cURL
curl -X POST https://api.tts.ai/v1/voice-convert/ \
  -H "Authorization: Bearer sk-tts-your-key" \
  -F "file=@source_audio.mp3" \
  -F "target_voice=af_bella" \
  -F "model=openvoice" \
  -o converted.wav

Kubvunzana

Inodzosera yakashandurwa audio faira se binary data.

Kushandura Kutaura

POST /v1/speech-translate/

Translate spoken audio from one language to another. Combines mashoko-ku-tebhu, kushandura, uye mashoko-ku-mashoko mune imwe nhare.

Kukumbira muviri (multipart/form-data)

Parameter_Ruvara:InodiwaKutaura
file file _Hapana Source audio file in the original language. Max 100MB.
target_language string _Hapana Nhamba yechinangwa chemitauro (e.g., es, fr, de, ja)
voice string Hapana Voice for translated output. Auto-selected if omitted.
preserve_voice boolean Hapana Kuedza kuchengeta munyori wekutanga

Kubvunzana

JSON mhinduro
{
  "original_text": "Hello, how are you?",
  "translated_text": "Hola, como estas?",
  "source_language": "en",
  "target_language": "es",
  "audio_url": "https://api.tts.ai/v1/results/translate_abc123.mp3",
  "credits_used": 5
}

Speech to SpeechName

POST /v1/speech-to-speech/

Kushandura chimiro chekutaura, pfungwa, kana kutumira uchichengeta zvinongedzo. Zvakanakira kudzora tone, pacing, uye expressionality.

Kukumbira muviri (multipart/form-data)

Parameter_Ruvara:InodiwaKutaura
file file _Hapana Source speech audio file. Max 50MB.
voice string _Hapana Target voice ID for the output speech
model string Hapana Model: openvoice (default), chatterbox
emotion string Hapana Target emotional: neutral, happy, sad, angry, excited
speed float Hapana Kugadzirisa kwesimba. Zviri pachena: 1.0. Kusiyana: 0.5 kusvika 2.0

Kubvunzana

Inodzosera yakashandurwa audio faira se binary data.

Zvishandiso zveSound

Audio processing endpoints for enhancement, vocal removal, stem splitting, and more.

POST /v1/audio/enhance/

Kuvandudza audio mhando: denoise, kuvandudza kujeka, super resolution.

file fileAudio file to enhance
denoise booleanKubvumira kubvisa ruzha (default: true)
enhance_clarity booleanKuwedzera kujeka kwemashoko (yakajairika: true)
super_resolution booleanKuwedzera audio quality (default: false)
strength integer1-3 (yakajeka, yakaderera, yakakwira). Default: 2
POST /v1/audio/separate/

Separate vowels kubva instrumentals (vowel kubvisa) kana kuparadzanisa mumabwe.

file fileAudio faira richaparadzanisa
model stringdemucs (default) kana spleeter
stems integerNhamba yezvipfuyo: 2, 4, 5, kana 6 (default: 2)
format stringOutput format: wav, mp3, flac
POST /v1/audio/dereverb/

Remove echo uye reverb kubva audio recordings.

file fileAudio file to process
type stringecho or reverb (default: both)
intensity integer1-5 (default: 3)
POST /v1/audio/analyze/ Vakasununguka

Analyze audio kuongorora key, BPM, uye nguva saini.

file fileAudio file to analyze
Kubvunzana
{
  "key": "C",
  "scale": "Major",
  "bpm": 120.0,
  "time_signature": "4/4",
  "camelot": "8B",
  "compatible_keys": ["C Major", "G Major", "F Major", "A Minor"]
}
POST /v1/audio/convert/ Vakasununguka

Kushandura audio pakati formats.

file fileAudio faira rinoshandurwa
format stringMufananidzo wemufananidzo
bitrate integerOutput bitrate in kbps: 64, 128, 192, 256, 320
sample_rate integerSample rate: 22050, 44100, 48000
channels stringmono kana stereo

Kutaura nezwi

POST /v1/voice-chat/

Kutumira audio kana meseji uye kugamuchira AI mhinduro ne synthesized mashoko.

Kukumbira muviri (multipart/form-data kana JSON)

Parameter_Ruvara:InodiwaKutaura
audio file Hapana* Audio input (audio kana text zvinodiwa)
text string Hapana* Kunyora (audio kana text zvinodiwa)
voice string Hapana Voice for AI response. Default: af_bella
tts_model string Hapana TTS model for response. Default: kokoro
system_prompt string Hapana Custom system prompt for the AI
conversation_id string Hapana Kuenderera mberi nekutaura kwazvino

Kubvunzana

JSON mhinduro
{
  "conversation_id": "conv_abc123",
  "user_text": "What is the capital of France?",
  "ai_text": "The capital of France is Paris.",
  "audio_url": "https://api.tts.ai/v1/audio/tmp/resp_xyz.mp3",
  "credits_used": 3
}

List Models

GET /v1/models/

Returns a list of all available models with their capabilities.

Kubvunzana

JSON mhinduro
{
  "models": [
    {
      "id": "kokoro",
      "name": "Kokoro",
      "type": "tts",
      "tier": "standard",
      "languages": ["en", "ja", "ko", "zh", "fr"],
      "supports_cloning": false,
      "supports_streaming": true,
      "credits_per_1k_chars": 2
    },
    {
      "id": "chatterbox",
      "name": "Chatterbox",
      "type": "tts",
      "tier": "premium",
      "languages": ["en"],
      "supports_cloning": true,
      "supports_streaming": true,
      "credits_per_1k_chars": 4
    }
  ]
}

List Voices

GET /v1/voices/

Inodzosera runyorwa rwese rwemazwi anowanikwa, kana zvichidikanwa, akachena nemodeli kana rurimi.

Query Parameters

Parameter_Ruvara:Kutaura
model string Filter by model ID (e.g., kokoro)
language string Kuchenesa nekodzero yechitauro (e.g., en)
gender string Sarudza nezera: murume, mukadzi, chaiyo

Kubvunzana

JSON mhinduro
{
  "voices": [
    {
      "id": "af_bella",
      "name": "Bella",
      "model": "kokoro",
      "language": "en",
      "gender": "female",
      "preview_url": "https://api.tts.ai/v1/voices/preview/af_bella.mp3"
    }
  ],
  "total": 142
}

Code Mifananidzo

Text to SpeechName

Python - requests
import requests

API_KEY = "sk-tts-your-key"

# Text to Speech
response = requests.post(
    "https://api.tts.ai/v1/tts/",
    headers={"Authorization": f"Bearer {API_KEY}"},
    json={
        "model": "kokoro",
        "text": "Hello from TTS.ai!",
        "voice": "af_bella",
        "format": "mp3"
    }
)

with open("output.mp3", "wb") as f:
    f.write(response.content)

print(f"Credits used: {response.headers.get('X-Credits-Used')}")

Kutaura-Ku-TekisiName

Python - requests
# Speech to Text
with open("recording.mp3", "rb") as f:
    response = requests.post(
        "https://api.tts.ai/v1/stt/",
        headers={"Authorization": f"Bearer {API_KEY}"},
        files={"file": f},
        data={"model": "faster-whisper", "timestamps": "true"}
    )

result = response.json()
print(result["text"])

Voice Cloning

Python - requests
# Voice Cloning
with open("reference.wav", "rb") as ref:
    response = requests.post(
        "https://api.tts.ai/v1/tts/clone/",
        headers={"Authorization": f"Bearer {API_KEY}"},
        files={"reference_audio": ref},
        data={
            "text": "This speech uses a cloned voice.",
            "model": "chatterbox"
        }
    )

with open("cloned_output.mp3", "wb") as f:
    f.write(response.content)

Text to SpeechName

JavaScript - fetch
const API_KEY = 'sk-tts-your-key';

// Text to Speech
const response = await fetch('https://api.tts.ai/v1/tts/', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    model: 'kokoro',
    text: 'Hello from TTS.ai!',
    voice: 'af_bella',
    format: 'mp3'
  })
});

const audioBlob = await response.blob();
const audioUrl = URL.createObjectURL(audioBlob);
const audio = new Audio(audioUrl);
audio.play();

Kutaura-Ku-TekisiName

JavaScript - fetch
// Speech to Text
const formData = new FormData();
formData.append('file', audioFile);
formData.append('model', 'faster-whisper');

const response = await fetch('https://api.tts.ai/v1/stt/', {
  method: 'POST',
  headers: { 'Authorization': `Bearer ${API_KEY}` },
  body: formData
});

const result = await response.json();
console.log(result.text);

Text to SpeechName

cURL
# Text to Speech
curl -X POST https://api.tts.ai/v1/tts/ \
  -H "Authorization: Bearer sk-tts-your-key" \
  -H "Content-Type: application/json" \
  -d '{"model":"kokoro","text":"Hello!","voice":"af_bella","format":"mp3"}' \
  -o output.mp3

Kutaura-Ku-TekisiName

cURL
# Speech to Text
curl -X POST https://api.tts.ai/v1/stt/ \
  -H "Authorization: Bearer sk-tts-your-key" \
  -F "file=@recording.mp3" \
  -F "model=faster-whisper" \
  -F "timestamps=true"

Voice Cloning

cURL
# Voice Cloning
curl -X POST https://api.tts.ai/v1/tts/clone/ \
  -H "Authorization: Bearer sk-tts-your-key" \
  -F "reference_audio=@reference.wav" \
  -F "text=This uses a cloned voice." \
  -F "model=chatterbox" \
  -o cloned.mp3

Kuvandudzwa kweSound

cURL
# Audio Enhancement
curl -X POST https://api.tts.ai/v1/audio/enhance/ \
  -H "Authorization: Bearer sk-tts-your-key" \
  -F "file=@noisy_audio.mp3" \
  -F "denoise=true" \
  -F "enhance_clarity=true" \
  -o enhanced.mp3

Kodhi dzematambudziko

Zvese matambudziko anodzokera JSON mhinduro ne error field.

Mufananidzo wemufananidzo
{
  "error": {
    "code": "insufficient_credits",
    "message": "You do not have enough credits for this request.",
    "credits_required": 4,
    "credits_available": 2
  }
}
HTTP StatusError CodeKutaura
400 bad_request Isingabvumirwe parameters yechikumbiro. Ona meseji yematambudziko kuti uwane zvakawanda.
401 unauthorized Isina kunaka kana isina kunaka API kiyi.
402 insufficient_credits Hapana zvikwereti zvakakwana. Purchase more at /pricing/.
403 forbidden API kuwanikwa haisi kuwanikwa pane yako chirongwa.
404 not_found Mufananidzo kana mutauro hauna kuwanikwa.
413 file_too_large Yakakwira faira iri kupfuura upamhi hunodiwa.
429 rate_limited Zvikumbiro zvakawanda zvikuru. Cheka rate limit headers.
500 internal_error Server error. Try again later.
503 model_loading Model is loading. Try again in a few seconds.

Webhooks

Kuti uite basa rinotora nguva yakareba (kuparadzanisa zvikamu, batch TTS), unogona kupa webhook_url parameter. Kana basa rapera, isu tichatumira mhinduro kune yako URL.

Webhook Payload
{
  "event": "task.completed",
  "task_id": "task_abc123",
  "status": "success",
  "result_url": "https://api.tts.ai/v1/results/task_abc123",
  "credits_used": 12,
  "created_at": "2025-01-15T10:30:00Z",
  "completed_at": "2025-01-15T10:30:45Z"
}
Webhook mhedzisiro inowanikwa kurodha pasi kwe 24 hrs mushure mekupedza. Uve nechokwadi chekurodha pasi nekukurumidza.

Ready to Build?

Get your API key and start integrating TTS.ai into your applications.