Uxwebhu lwe-API
Yongeza i-TTS.ai kwizicelo zakho nge-REST API yethu. Ifomati ehambelana ne-OpenAI yokufuduka ngokulula.
Isishwankathelo
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.
Isitshixo se-API
Fumana iqhosha lakho le-API ukusuka Izicwangciso ze-akhawunti. Ifumaneka kwiinkqubo zePro kunye neEnterprise.
Isiseko se URL
https://api.tts.ai/v1/
Ugunyaziso:
Umthumeli we-token nge- Authorization okubhalwe emantla ephepha
Uqinisekiso
Zonke izicelo ze-API zifuna uqinisekiso nge-Bearer token Authorization okubhalwe emantla ephepha.
Authorization: Bearer sk-tts-your-api-key-here
Isiseko se URL
Zonke iziphelo zihambelana nale siseko se URL. Umzekelo, isiphelo se TTS si:
Amagqabantshintshi
Umda wexabiso le-API luhluka ngokwenkqubo:
| I-Plan | Izicelo/umzuzu | Concurrent | Ubude bombhalo obuphezulu ephepheni |
|---|---|---|---|
| I-Pro | 60 | 5 | 5,000 iimpawu |
| I-Entreprise | 300 | 20 | 50,000 iimpawu |
Umda wexabiso lombhalo ophezulu ephepheni uqukiwe kwimpendulo nganye: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.
Iindleko zetyala
| Inkonzo | Ixabiso | Iyunithi |
|---|---|---|
| TTS (Iimodeli ezikhululekileyo: i-Piper, i-VITS, i-MeloTTS) | 1 credit | Iimpawu ezili-1000 nganye |
| TTS (Iimodeli eziqhelekileyo: Kokoro, CosyVoice 2, njl.njl.) | 2 credits | Iimpawu ezili-1000 nganye |
| TTS (Iimodeli zePremium: Tortoise, Chatterbox, njl. njl.) | 4 credits | Iimpawu ezili-1000 nganye |
| Uthetha ukuba UmbhaloName | 2 credits | umzuzu wesandi nganye |
| I-Voice Cloning | 4 credits | Iimpawu ezili-1000 nganye |
| Umtshintshi WesandiName | 3 credits | umzuzu wesandi nganye |
| Ukuphuculwa kwesandi | 2 credits | umzuzu wesandi nganye |
| Ukususa iVocal / Ukwahlula iVoice | 3-4 credits | umzuzu wesandi nganye |
| Uguqulelo lomsebenzi kolunye ulwimi | 5 credits | umzuzu wesandi nganye |
| Incoko YelizwiName | 3 credits | Ujikelezo ngalunye |
| Isitshixo & BPM Umfumani | Ekhululekileyo | -- |
| Umguquli WesandiName | Ekhululekileyo | -- |
Okubhaliweyo ukuya kuSpeechName
Guqulela umbhalo kwisandi sokuthetha. Ibuyisela ifayile yesandi kwifomati eceliweyo.
Isiqu Sesicelo
| Parameters | Udidi | Ifunekayo | Inkcazelo |
|---|---|---|---|
| model | string | Hayi | Imodeli ye-ID (umzekelo, kokoro, chatterbox, piper) |
| text | string | Hayi | Umbhalo oguqulwe kwilizwi (max 5,000 characters for Pro, 50,000 for Enterprise) |
| voice | string | Hayi | I-Voice ID (sebenzisa /v1/voices/ uluhlu lwee-voices ezifumanekayo) |
| format | string | Akukho nanye | Ifomati yemveliso: mp3 (emiselweyo), wav, flac, ogg |
| speed | float | Akukho nanye | Ukuphindaphinda kwesantya sokuthetha. Okumiselweyo: 1.0. Uluhlu: 0.5 ukuya 2.0 |
| language | string | Akukho nanye | Ikhowudi yoLwimi (umzekelo, en, es). Ifunyanwa ngokuzenzekelayo ukuba ilahlekile. |
| stream | boolean | Akukho nanye | Yenza ukuba kusebenze unikezelo lwempendulo. Okumiselweyo: false |
Isicelo Somzekelo
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
Impendulo
Returns the audio file as binary data with appropriate Content-Type header (audio/mpeg, audio/wav, etc.).
Content-Type: audio/mpeg
Content-Length: 48256
X-Credits-Used: 2
X-Credits-Remaining: 498
Uthetha ukuba UmbhaloName
Uguqulelo lwesandi kumbhalo. Ixhasa iilwimi ezili-99 ngokukhangela okuzenzekelayo.
Isiqu Sesicelo (multipart/form-data)
| Parameters | Udidi | Ifunekayo | Inkcazelo |
|---|---|---|---|
| file | file | Hayi | Ifayili enesandi (MP3, WAV, FLAC, OGG, M4A, MP4, WebM). Ubuninzi 100MB. |
| model | string | Akukho nanye | Imodeli ye-STT: whisper (emiselweyo), faster-whisper, sensevoice
|
| language | string | Akukho nanye | Ikhowudi yoLwimi. auto yokufumanisa ngokuzenzekelayo (okungagqibekanga). |
| timestamps | boolean | Akukho nanye | Quka ii-timestamps ezikwinqanaba legama. Okumiselweyo: false |
| diarize | boolean | Akukho nanye | Yenza i-diary yomthumeli isebenze. Okumiselweyo: false |
Impendulo
{
"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"
}
]
}
I-Voice Cloning
Yenza ukuthetha ngelizwi eliklonyelweyo. Layisha phezulu umbhalo nolwaziso lwesandi.
Isiqu Sesicelo (multipart/form-data)
| Parameters | Udidi | Ifunekayo | Inkcazelo |
|---|---|---|---|
| reference_audio | file | Hayi | Uluhlu lwesandi sesandi (10-30 imizuzwana ecetyiswayo). Max 20MB. |
| text | string | Hayi | Umbhalo oza kuthetha ngesiquphe. |
| model | string | Akukho nanye | Imodeli ye-clone: chatterbox (emiselweyo), cosyvoice2, gpt-sovits
|
| format | string | Akukho nanye | Ifomati yemveliso: mp3 (emiselweyo), wav, flac |
| language | string | Akukho nanye | Ikhowudi yolwimi lwenjongo. Kufuneka ixhaswe yimodeli ekhethiweyo. |
Impendulo
Ibuyisela ifayile yesandi njenge data ephindwe kabini, efanayo ne-TTS endpoint.
Umtshintshi WesandiName
Guqula isandi ukuba sisebenze njengesandi esihlukileyo. Layisha phezulu imvelaphi yesandi uze ukhethe ilizwi elibekiweyo.
Isiqu Sesicelo (multipart/form-data)
| Parameters | Udidi | Ifunekayo | Inkcazelo |
|---|---|---|---|
| file | file | Hayi | Umthombo wefayili yesandi (MP3, WAV, FLAC). Ubuninzi be-50MB. |
| target_voice | string | Hayi | I-ID yesandi esimiselweyo sokuguqulela kuyo (sebenzisa /v1/voices/ uluhlu lweesandi ezifumanekayo) |
| model | string | Akukho nanye | Imodeli yokuguqula ilizwi: openvoice (emiselweyo), knn-vc |
| format | string | Akukho nanye | Ifomati yemveliso: wav (emiselweyo), mp3, flac |
Isicelo Somzekelo
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
Impendulo
Ibuyisela ifayile yesandi eguqulweyo njenge data ephindwe kabini.
Uguqulelo lomsebenzi kolunye ulwimi
Guqulela isandi esithethayo ukusuka kwilwimi elinye ukuya kwelinye. Idibanisa ulwimi-ku-mbhalo, uguqulelo, kunye nombhalo-ku-ulwimi kwintlanganiso enye.
Isiqu Sesicelo (multipart/form-data)
| Parameters | Udidi | Ifunekayo | Inkcazelo |
|---|---|---|---|
| file | file | Hayi | Umthombo wefayili yesandi ngolwimi olungagqibekanga. Max 100MB. |
| target_language | string | Hayi | Ikhowudi yoLwimi oluSebenzayo (umzekelo. es, fr, de, ja) |
| voice | string | Akukho nanye | Ilizwi lemveliso eguqulelweyo. Ikhethiwe ngokuzenzekelayo ukuba ilahliwe. |
| preserve_voice | boolean | Akukho nanye | Zama ukugcina isandi sokuqala |
Impendulo
{
"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
}
Ukuthetha-thethana
Guqula indlela yokuthetha, intuthuzelo, okanye unikezelo ngelixa ugcina imixholo. Isetyenziswa ukucwangcisa ithoni, ukukhawulezisa, kunye nokuchaza.
Isiqu Sesicelo (multipart/form-data)
| Parameters | Udidi | Ifunekayo | Inkcazelo |
|---|---|---|---|
| file | file | Hayi | Umthombo wefayili yesandi yesandi. Max 50MB. |
| voice | string | Hayi | Isiphelo se-ID yelizwi lemveliso yokuthetha |
| model | string | Akukho nanye | Imodeli: openvoice (emiselweyo), chatterbox
|
| emotion | string | Akukho nanye | I-target emotion: neutral, happy, sad, angry, excited
|
| speed | float | Akukho nanye | Ulungelelaniso lwesantya. Okumiselweyo: 1.0. Uluhlu: 0.5 ukuya 2.0 |
Impendulo
Ibuyisela ifayile yesandi eguqulwe kancinane njenge data yesibini.
Izixhobo zesandi
Iziphelo zokuqhubekeka kwesandi zokuphucula, ukususwa kwesandi, ukuhlukaniswa kwe-stem, kunye nezinye izinto.
Yenza ngcono umgangatho wesandi: i-denoise, yenza ngcono ucacileyo, isisombululo esiphezulu.
| file file | Ifayile enesandi ekufuneka iphuculwe |
| denoise boolean | Yenza i-denoise (emiselweyo: inyaniso) |
| enhance_clarity boolean | Yongeza ukubonakala kokuthetha (okungagqibekanga: inyaniso) |
| super_resolution boolean | Yongeza ubunjani besandi (okungagqibekanga: ubuxoki) |
| strength integer | 1- 3 (ekhanyayo, ephakathi, enamandla). Okwendalo: 2 |
Yahlula izithethi kwizixhobo (ukususwa kwezithethi) okanye yahlula ibe ziistems.
| file file | Ifayile enesandi emayihlukaniswe |
| model string | demucs (Okumiselweyo) okanye spleeter |
| stems integer | Inani lee-stems: 2, 4, 5, okanye 6 (okwendalo: 2) |
| format string | Ifomati yemveliso: wav, mp3, flac |
Susa i-echo ne-reverb kwi-audio recordings.
| file file | Ifayile yesandi emayiqhubekekwe nayo |
| type string | echo or reverb (default: both) |
| intensity integer | 1-5 (default: 3) |
Yenza uphando lwesandi ukuze ufumane iqhosha, i-BPM, notyikityo lwexesha.
| file file | Audio file to analyze |
{
"key": "C",
"scale": "Major",
"bpm": 120.0,
"time_signature": "4/4",
"camelot": "8B",
"compatible_keys": ["C Major", "G Major", "F Major", "A Minor"]
}
Guqula isandi phakathi kweefomati.
| file file | Ifayile yesandi emayiguqulwe |
| format string | Ubume benjongo: mp3, wav, flac, ogg, m4a, aac |
| bitrate integer | Imveliso ye bitrate kwi kbps: 64, 128, 192, 256, 320 |
| sample_rate integer | Isampuli: 22050, 44100, 48000 |
| channels string | mono okanye stereo |
Incoko YelizwiName
Thumela isandi okanye umbhalo uze ufumane impendulo ye-AI ngelizwi elidityanisiweyo.
Isiqu Sesicelo (multipart/form-data okanye JSON)
| Parameters | Udidi | Ifunekayo | Inkcazelo |
|---|---|---|---|
| audio | file | Akukho nanye* | Ungeniso lwesandi (okanye audio okanye text lufuneka) |
| text | string | Akukho nanye* | Ungeniso lombhalo (okanye audio okanye text olufunekayo) |
| voice | string | Akukho nanye | Ilizwi le-AI eliphendulayo. Elingagqibekanga: af_bella |
| tts_model | string | Akukho nanye | Imodeli ye-TTS yempendulo. Okumiselweyo: kokoro |
| system_prompt | string | Akukho nanye | Isilumkiso sendlela yokusebenza yesiko ye-AI |
| conversation_id | string | Akukho nanye | Qhubeka nonxibelelwano olukhoyo |
Impendulo
{
"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
}
Uluhlu lweemodeli
Ibuyisela uluhlu lwazo zonke iimodyuli ezifumanekayo kunye neempawu zawo.
Impendulo
{
"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
}
]
}
Uluhlu Lwesandi
Ibuyisela uluhlu lwazo zonke iimpikiswano ezifumanekayo, ezihluziweyo ngokwendlela okanye ulwimi.
Iparameters Zombuzo
| Parameters | Udidi | Inkcazelo |
|---|---|---|
| model | string | Icebo lokucoca ulwelo ngemodeli ye-ID (umzekelo, kokoro) |
| language | string | Icebo lokucoca ulwelo ngekhowudi yolwimi (umzekelo. en) |
| gender | string | Icebo lokucoca ulwelo ngokwesini: male, female, neutral |
Impendulo
{
"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
}
Imizekelo yekhowudi
Okubhaliweyo ukuya kuSpeechName
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')}")
Uthetha ukuba UmbhaloName
# 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"])
I-Voice Cloning
# 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)
Okubhaliweyo ukuya kuSpeechName
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();
Uthetha ukuba UmbhaloName
// 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);
Okubhaliweyo ukuya kuSpeechName
# 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
Uthetha ukuba UmbhaloName
# 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"
I-Voice Cloning
# 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
Ukuphuculwa kwesandi
# 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
Iikhowudi zemposiso
Zonke iimposiso zibuyisela uphendulo lwe-JSON nge- error Iindawo zokugcina
{
"error": {
"code": "insufficient_credits",
"message": "You do not have enough credits for this request.",
"credits_required": 4,
"credits_available": 2
}
}
| Isimo se HTTP | Error Code | Inkcazelo |
|---|---|---|
| 400 | bad_request |
Iparameters zesicelo esingasebenziyo. Khangela umyalezo wemposiso ngeenkcukacha. |
| 401 | unauthorized |
Isitshixo se-API esilahlekileyo okanye esingasebenziyo. |
| 402 | insufficient_credits |
Akukho matyala aninzi. Thenga ngaphezulu kwi /pricing/. |
| 403 | forbidden |
Ufikelelo lwe-API alufumanekanga kwinkqubo yakho. |
| 404 | not_found |
Imodeli okanye ilizwi alifumanekanga. |
| 413 | file_too_large |
Ifayile elayishwe ngaphezulu idlula umda wobungakanani. |
| 429 | rate_limited |
Isicelo esininzi kakhulu. Khangela umda wokubhaliweyo okuphezulu kwephepha. |
| 500 | internal_error |
Imposiso yomncedisi. Zama kwakhona kamva. |
| 503 | model_loading |
Imodeli iyalayisha. Zama kwakhona kwimizuzu embalwa. |
I-Webhooks
Umsebenzi osebenza ixesha elide (ukwahlula i-stem, i-batch TTS), ungabonelela nge webhook_url parameter. Xa umsebenzi ugqityiwe, siya ku-POST isiphumo kwi-URL yakho.
{
"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"
}
Ilungile ukwakha?
Fumana iqhosha lakho le-API kwaye uqalise ukudibanisa i-TTS.ai kwiinkqubo zakho.