Dokumentazzjoni tal-API

Integra TTS.ai fl-applikazzjonijiet tiegħek mal-REST API tagħna. OpenAI-format kompatibbli għall-migrazzjoni faċli.

REST API Kompatibbli ma’ OpenAI Tweġibiet JSON Appoġġ għall-Istrimjar

Ħarsa ġenerali

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.

Ċavetta tal-API

Ikseb iċ-ċavetta API tiegħek minn Settings tal-Kont. Disponibbli fuq il-pjanijiet Pro u Enterprise.

URL bażiku

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

Awtorizzazzjoni

Token tad-detentur permezz ta’ Authorization intestatura

Awtentikazzjoni

It-talbiet kollha tal-API jeħtieġu awtentikazzjoni permezz ta’ Bearer token fil- Authorization intestatura.

Intestatura HTTP
Authorization: Bearer sk-tts-your-api-key-here
Żomm iċ-ċavetta API tiegħek sigrieta. M'għandekx taqsamha fil-kodiċi tan-naħa tal-klijent, repożitorji pubbliċi, jew żraben.Rotate ċwievet regolarment mill-settings tal-kont tiegħek.

URL bażiku

URL bażiku: 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/

Limiti tar-rata

API rate limits vary by plan:

Pjan Talbiet/min Concurrent Tul massimu tat-test
Għaliex 60 5 5,000 karattru
Intrapriża 300 20 50,000 karattru

L-intestaturi tal-limitu tar-rata huma inklużi f’kull tweġiba: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

Spejjeż tal-kreditu

Servizz Spejjeż Unità
TTS (mudelli ħielsa: Piper, VITS, MeloTTS) 1 kreditu għal kull 1,000 karattru
TTS (mudelli standard: Kokoro, CosyVoice 2, eċċ.) 2 krediti għal kull 1,000 karattru
TTS (mudelli Premium: Tortoise, Chatterbox, eċċ.) 4 krediti għal kull 1,000 karattru
Diskors għal Test 2 krediti kull minuta ta’ awdjo
Klonazzjoni tal-vuċi 4 krediti għal kull 1,000 karattru
Bidla tal-vuċi 3 krediti kull minuta ta’ awdjo
Titjib tal-awdjo 2 krediti kull minuta ta’ awdjo
Tneħħija vokali / Qsim taż-żerriegħa 3-4 krediti kull minuta ta’ awdjo
Traduzzjoni tad-diskors 5 krediti kull minuta ta’ awdjo
Chat bil-vuċi 3 krediti għal kull dawra
Ewlenin & BPM Finder Liberi --
Konvertitur tal-awdjo Liberi --

Test għal Diskors

POST /v1/tts/

Ikkonverti test għall-awdjo diskors. Jirritorna fajl awdjo fil-format mitlub.

Korp tat-talba

ParametruTipMeħtieġaDeskrizzjoni
model string Iva ID tal-mudell (eż. kokoro, chatterbox, piper)
text string Iva Test biex tikkonverti għal diskors (massimu 5,000 karattri għall Pro, 50,000 għall-Intrapriża)
voice string Iva Voice ID (uża /v1/voices/ biex telenka l-vuċijiet disponibbli)
format string L-ebda Format tal-output: mp3 (predefinit), wav, flac, ogg
speed float L-ebda Multiplikatur tal-veloċità tat-taħdit. Default: 1.0. Range: 0.5 to 2.0
language string L-ebda Kodiċi tal-lingwa (eż. en, es). Jinstab awtomatikament jekk jitħalla barra.
stream boolean L-ebda Attiva r-rispons tal-istreaming. Default: false

Eżempju ta’ Talba

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

Rispons

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

Intestaturi tar-Rispons
Content-Type: audio/mpeg
Content-Length: 48256
X-Credits-Used: 2
X-Credits-Remaining: 498

Diskors għal Test

POST /v1/stt/

Traskrizzjoni awdjo għat-test. Jappoġġja 99 lingwi bil-awto-sejbien.

Korp tat-talba (multipart/form-data)

ParametruTipMeħtieġaDeskrizzjoni
file file Iva Fajl awdjo (MP3, WAV, FLAC, OGG, M4A, MP4, WebM). Max 100MB.
model string L-ebda Mudell STT: whisper (default), faster-whisper, sensevoice
language string L-ebda Kodiċi tal-lingwa. auto għall-iskoperta awtomatika (default).
timestamps boolean L-ebda Inkludi timestamps fil-livell tal-kelma. Default: false
diarize boolean L-ebda Attiva d-dijarizzazzjoni tal-kelliem. Default: false

Rispons

Rispons JSON
{
  "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"
    }
  ]
}

Klonazzjoni tal-vuċi

POST /v1/tts/clone/

Jiġġeneraw diskors fil-vuċi kklonat. Upload referenza awdjo u test.

Korp tat-talba (multipart/form-data)

ParametruTipMeħtieġaDeskrizzjoni
reference_audio file Iva Referenza vuċi awdjo (10-30 sekonda rakkomandati). Max 20MB.
text string Iva Test biex jitkellmu fil-vuċi klonizzati.
model string L-ebda Mudell tal-klonu: chatterbox (default), cosyvoice2, gpt-sovits
format string L-ebda Format tal-output: mp3 (default), wav, flac
language string L-ebda Kodiċi tal-lingwa fil-mira. Għandu jkun appoġġjat mill-mudell magħżul.

Rispons

Jirritorna l-fajl awdjo bħala data binarju, l-istess bħall-punt aħħari TTS.

Bidla tal-vuċi

POST /v1/voice-convert/

Ikkonverti l-awdjo biex ħoss bħal vuċi differenti. Upload awdjo sors u jagħżlu vuċi fil-mira.

Korp tat-talba (multipart/form-data)

ParametruTipMeħtieġaDeskrizzjoni
file file Iva Fajl awdjo sors (MP3, WAV, FLAC). Max 50MB.
target_voice string Iva ID tal-vuċi fil-mira li trid tikkonverti (uża /v1/voices/ biex telenka l-vuċijiet disponibbli)
model string L-ebda Mudell ta’ konverżjoni tal-vuċi: openvoice (default), knn-vc
format string L-ebda Format tal-output: wav (default), mp3, flac

Eżempju ta’ Talba

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

Rispons

Jirritorna l-fajl awdjo konvertiti bħala data binarju.

Traduzzjoni tad-diskors

POST /v1/speech-translate/

Ittraduċi l-awdjo mitkellem minn lingwa għall-oħra.Tgħaqqad diskors-to-test, traduzzjoni, u test-to-diskors f'sejħa waħda.

Korp tat-talba (multipart/form-data)

ParametruTipMeħtieġaDeskrizzjoni
file file Iva Fajl awdjo tas-sors fil-lingwa oriġinali. Max 100MB.
target_language string Iva Kodiċi tal-lingwa fil-mira (eż. es, fr, de, ja)
voice string L-ebda Leħen għall-output tradott. Magħżul awtomatikament jekk omm.
preserve_voice boolean L-ebda Tentattiv biex jippreservaw l-kelliem oriġinali

Rispons

Rispons JSON
{
  "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
}

Diskors għal Diskors

POST /v1/speech-to-speech/

Transform speech style, emotion, or delivery while keeping the content. Useful for adjusting tone, pacing, and expressiveness.

Korp tat-talba (multipart/form-data)

ParametruTipMeħtieġaDeskrizzjoni
file file Iva Fajl awdjo tad-diskors tas-sors. Max 50MB.
voice string Iva ID tal-vuċi fil-mira għad-diskors tal-produzzjoni
model string L-ebda Mudell: openvoice (default), chatterbox
emotion string L-ebda Emozzjoni fil-mira: newtrali, ferħan, imdejjaq, irrabjat, eċċitat
speed float L-ebda Aġġustament tal-veloċità. Default: 1.0. Medda: 0.5 sa 2.0

Rispons

Jirritorna l-fajl awdjo trasformati bħala data binarju.

Għodod tal-awdjo

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

POST /v1/audio/enhance/

Ittejjeb il-kwalità tal-awdjo: denoise, ittejjeb iċ-ċarezza, riżoluzzjoni super.

file fileFajl awdjo biex ittejjeb
denoise booleanAttiva l-eliminazzjoni tal-ħsejjes (default: true)
enhance_clarity booleanIttejjeb iċ-ċarezza tad-diskors (default: veru)
super_resolution booleanUpscale kwalità awdjo (default: falza)
strength integer1-3 (dawl, medju, qawwi). Default: 2
POST /v1/audio/separate/

Separa vokali minn strumentali (tneħħija vokali) jew maqsuma fi zkuk.

file fileFajl tal-awdjo biex jissepara
model stringdemucs (default) jew spleeter
stems integerNumru ta' zkuk: 2, 4, 5, jew 6 (default: 2)
format stringFormat tal-output: wav, mp3, flac
POST /v1/audio/dereverb/

Neħħi eko u reverb minn reġistrazzjonijiet awdjo.

file fileFajl awdjo li għandu jiġi pproċessat
type stringecho or reverb (default: both)
intensity integer1-5 (default: 3)
POST /v1/audio/analyze/ Liberi

Analizza l-awdjo biex tiskopri ċavetta, BPM, u l-firma tal-ħin.

file fileFajl awdjo biex jiġi analizzat
Rispons
{
  "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/ Liberi

Ikkonverti awdjo bejn il-formati.

file fileFajl awdjo biex jikkonverti
format stringTarget format: mp3, wav, flac, ogg, m4a, aac
bitrate integerBitrate tal-output f’kbps: 64, 128, 192, 256, 320
sample_rate integerRata tal-kampjun: 22050, 44100, 48000
channels stringmono jew stereo

Chat bil-vuċi

POST /v1/voice-chat/

Ibgħat awdjo jew test u tirċievi tweġiba AI b'diskors sintetizzat.

Korp tat-talba (multipart/form-data jew JSON)

ParametruTipMeħtieġaDeskrizzjoni
audio file L-ebda* Input awdjo (jew awdjo jew test meħtieġ)
text string L-ebda* Input tat-test (jeħtieġ awdjo jew test)
voice string L-ebda Leħen għat-tweġiba tal-AI. Default: af_bella
tts_model string L-ebda Mudell TTS għar-rispons. Default: kokoro
system_prompt string L-ebda Custom sistema prompt għall-AI
conversation_id string L-ebda Tkompli konverżazzjoni eżistenti

Rispons

Rispons JSON
{
  "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
}

Lista tal-mudelli

GET /v1/models/

Jirritorna lista tal-mudelli kollha disponibbli bil-kapaċitajiet tagħhom.

Rispons

Rispons JSON
{
  "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
    }
  ]
}

Lista ta’ vuċijiet

GET /v1/voices/

Jirritorna lista tal-vuċijiet kollha disponibbli, fakultattivament iffiltrati skont il-mudell jew il-lingwa.

Parametri tal-mistoqsija

ParametruTipDeskrizzjoni
model string Iffiltra skont l-ID tal-mudell (eż. kokoro)
language string Iffiltra skont il-kodiċi tal-lingwa (eż. mt)
gender string Iffiltra skont is-sess: irġiel, nisa, newtrali

Rispons

Rispons JSON
{
  "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
}

Eżempji ta’ Kodiċi

Test għal Diskors

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')}")

Diskors għal Test

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"])

Klonazzjoni tal-vuċi

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)

Test għal Diskors

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();

Diskors għal Test

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);

Test għal Diskors

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

Diskors għal Test

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"

Klonazzjoni tal-vuċi

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

Titjib tal-awdjo

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

Kodiċijiet ta’ żball

L-iżbalji kollha jirritorna tweġiba JSON b' error qasam.

Format tar-Rispons ta’ Żball
{
  "error": {
    "code": "insufficient_credits",
    "message": "You do not have enough credits for this request.",
    "credits_required": 4,
    "credits_available": 2
  }
}
Status tal-HTTPError CodeDeskrizzjoni
400 bad_request Parametri tat-talba mhux validi. Iċċekkja l-messaġġ tal-iżball għad-dettalji.
401 unauthorized Ċavetta API nieqsa jew invalida.
402 insufficient_credits Mhux biżżejjed krediti. Ixtri aktar fuq /pricing/.
403 forbidden Aċċess API mhux disponibbli fuq il-pjan tiegħek.
404 not_found Il-mudell jew il-vuċi ma nstabux.
413 file_too_large Il-fajl imtella jaqbeż il-limitu tad-daqs.
429 rate_limited Rikjesti wisq. Iċċekkja l-intestaturi tal-limitu tar-rata.
500 internal_error Żball tas-server. Ipprova mill-ġdid aktar tard.
503 model_loading Mudell qed jillowdja. Ipprova mill-ġdid fi ftit sekondi.

Webhooks

Għal kompiti fit-tul (qsim taż-żerriegħa, TTS tal-lott), tista’ tipprovdi parametru webhook_url.Meta l-kompitu jitlesta, aħna nippubblikaw ir-riżultat fil-URL tiegħek.

Payload tal-Webhook
{
  "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"
}
Ir-riżultati tal-webhook huma disponibbli biex jitniżżlu għal 24 siegħa wara t-tlestija, għalhekk kun żgur li tniżżilhom minnufih.

Lesta biex tibni?

Ikseb iċ-ċavetta API tiegħek u ibda tintegra TTS.ai fl-applikazzjonijiet tiegħek.