Дакументацыя API

Інтэграваць TTS.ai у вашыя праграмы з дапамогай нашага REST API. Формат сумяшчальны з OpenAI для лёгкай міграцыі.

API REST Сумяшчальны з OpenAI Адказы JSON Падтрымка стрымінгу

Прагляд

API TTS.ai забяспечвае праграмны доступ да ўсіх магчымасцяў платформы: сінтэз тэксту ў мову, транскрыпцыя тэксту ў мову, клонаванне голасу, паляпшэнне гуку і інш. API выкарыстоўвае стандартныя REST-канвенцыі з запытамі/адказамі JSON.

Ключ API

Атрымаць ваш ключ API з Настаўленні рахунка. Працаваў на прадпрыемствах і ў арганізацыях.

Базавы URL

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

Аўтарызацыя

Токен носьбіта праз Authorization загаловак

Аўтарызацыя

Усе запыты API патрабуюць аўтэнтыфікацыі праз токен носьбіта ў Authorization загаловак.

Загаловак HTTP
Authorization: Bearer sk-tts-your-api-key-here
Захоўвайце свой ключ API ў сакрэце. Не выкарыстоўвайце яго ў кліенцкім кодзе, публічных сховішчах або часопісах. Рэгулярна змяняйце ключы ў наладах вашага рахунку.

Базавы URL

Базавы URL: https://api.tts.ai/v1/

Усе канцавыя кропкі адносяцца да гэтага базіснага URL. Напрыклад, канцавая кропка TTS:

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

Абмежаванні хуткасці

Абмежаванні хуткасці API залежаць ад плана:

Плошча Запытаў/ хвіліну Паралельна Максімальная даўжыня тэксту
Прафесійны 60 5 5000 знакаў
Кампанія 300 20 50 000 знакаў

Загаловак абмежавання хуткасці ўключаецца ў кожны адказ: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

Крэдытныя выдаткі

Сервіс Кошт Аб' ект
TTS (свабодныя мадэлі: Piper, VITS, MeloTTS) Крэдыт на 1000 знакаў
TTS (Стандартныя мадэлі: Kokoro, CosyVoice 2 і інш.) 2 крэдыту на 1000 знакаў
TTS (прэміум-мадэлі: Tortoise, Chatterbox і інш.) 4 крэдыту на 1000 знакаў
Пераклад з мовы на тэкстName 2 крэдыту за хвіліну гуку
Клонаванне голасу 4 крэдыту на 1000 знакаў
Зменнік голасуName 3 ачкі за хвіліну гуку
Пашырэнне гукуName 2 крэдыту за хвіліну гуку
Выдаленне голасу / Падзяленне голасу 3- 4 крэдыту за хвіліну гуку
Пераклад гаворкіName 5 ачкоў за хвіліну гуку
Галасовы чатName 3 ачкі на ход
Пошук ключоў і BPM Свабодны --
Аудыа канвэртарName Свабодны --

Пераклад тэксту на мовуName

POST /v1/tts/

Ператварэнне тэксту ў гаворку. Верне аўдыёфайл у запытаным фармаце.

Тэла запыту

Параметры& Тып:Неабходны& Апісанне:
model string Так ID мадэлі (напр., kokoro, chatterbox, piper)
text string Так Тэкст для пераўтварэння ў размову (макс. 5000 знакаў для Pro, 50000 для Enterprise)
voice string Так ID голасу (выкарыстоўвайце /v1/voices/ для спісу даступных галасоў)
format string Няма Фармат вываду: mp3 (па змаўчанні), wav, flac, ogg
speed float Няма Множнік хуткасці маўлення. Па змаўчанні: 1.0. Дыяпазон: ад 0.5 да 2.0
language string Няма Код мовы (напрыклад, en, es). Аўтаматычнае выяўленне, калі прапушчаны.
stream boolean Няма Па змаўчанні: false

Прыклад запыту

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

Адказ

Верне аўдыё файл як бінарныя дадзеныя з адпаведным загалоўкам Content-Type (audio/mpeg, audio/wav і г. д.).

Загаловак адказу
Content-Type: audio/mpeg
Content-Length: 48256
X-Credits-Used: 2
X-Credits-Remaining: 498

Пераклад з мовы на тэкстName

POST /v1/stt/

Ператварэньне аўдыё ў тэкст. Падтрымка 99 моваў з аўтавызначэньнем.

Тэла запыту (multipart/form-data)

Параметры& Тып:Неабходны& Апісанне:
file file Так Аўдыё файл (MP3, WAV, FLAC, OGG, M4A, MP4, WebM). Макс. 100 Мб.
model string Няма Модэль STT: шэптам (па змаўчанні), хутчэй-шэптам, разумны голас
language string Няма Код мовы. auto для аўтаматычнага выяўлення (па змаўчанні).
timestamps boolean Няма Уключыць час на ўзроўні слова. Па змаўчанні: false
diarize boolean Няма Па змаўчанні: false

Адказ

Адказ 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"
    }
  ]
}

Клонаванне голасу

POST /v1/tts/clone/

Стварыць размову з дапамогай кланаванага голасу. Загрузіць аўдыё і тэкст. Name

Тэла запыту (multipart/form-data)

Параметры& Тып:Неабходны& Апісанне:
reference_audio file Так Рэферэнцыйны гукавы файл (рэкамендуецца 10- 30 секунд). Макс. 20 Мб.
text string Так Тэкст для вымаўлення клонаваным голасам.
model string Няма Модэль клону: chatterbox (па змаўчанні), cosyvoice2, gpt-sovits
format string Няма Фармат вываду: mp3 (па змаўчанні), wav, flac
language string Няма Код мэтавай мовы. Ён павінен падтрымлівацца выбранай мадэллю.

Адказ

Верне аўдыёфайл у выглядзе бінарных дадзеных, такіх жа, як і канец TTS.

Зменнік голасуName

POST /v1/voice-convert/

Пераўтварыць гук у іншы голас. Загрузіць зыходны гук і выбраць зыходны голас.

Тэла запыту (multipart/form-data)

Параметры& Тып:Неабходны& Апісанне:
file file Так Аўдыёфайл (MP3, WAV, FLAC). Макс. 50 Мб.
target_voice string Так Ідэнтыфікатар галасоў для пераўтварэння (выкарыстоўвайце /v1/voices/ для пераліку даступных галасоў)
model string Няма Модэль пераўтварэння голасу: openvoice (па змаўчанні), knn-vc
format string Няма Фармат вываду: wav (па змаўчанні), mp3, flac

Прыклад запыту

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

Адказ

Верне пераўтвораны аўдыёфайл у выглядзе бінарных дадзеных.

Пераклад гаворкіName

POST /v1/speech-translate/

Пераклад гукавых паведамленьняў з адной мовы на іншую. Аб'ядноўвае пераклад з мовы на тэкст, пераклад з мовы на тэкст і пераклад з тэксту на мову ў адным выкліку.

Тэла запыту (multipart/form-data)

Параметры& Тып:Неабходны& Апісанне:
file file Так Аўдыёфайл на арыгінальнай мове. Макс. 100 Мб.
target_language string Так Код мэтавай мовы (напрыклад, es, fr, de, ja)
voice string Няма Голас для вываду перакладу. Аўтаматычна выбіраецца, калі прапушчаны.
preserve_voice boolean Няма Спрабаваць захаваць арыгінальны дынамік

Адказ

Адказ 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
}

Пераклад з мовы на гаворку

POST /v1/speech-to-speech/

Змяніць стыль гаворкі, эмоцыі, або выказванне, захоўваючы змест. Карысна для наладкі тону, тэмпу і выразнасці.

Тэла запыту (multipart/form-data)

Параметры& Тып:Неабходны& Апісанне:
file file Так Аўдыёфайл зыходнай гутаркі. Макс. 50 Мб.
voice string Так Ідэнтыфікатар голасу вываду
model string Няма Шаблон: openvoice (па змаўчанні), chatterbox
emotion string Няма Цэль эмоцыі: нейтральны, шчаслівы, смутны, злы, захоплены
speed float Няма Рэгуляванне хуткасці. Па змаўчанні: 1. 0. Дыяпазон: ад 0. 5 да 2. 0

Адказ

Верне пераўтвораны аўдыёфайл у выглядзе бінарных дадзеных.

АўдыёName

Крайнія пункты апрацоўкі аўдыё для паляпшэння, выдалення голасу, падзелу сцябла і інш.

POST /v1/audio/enhance/

Павялічыць якасць гуку: выдаленне шуму, паляпшэнне чысціні, высокая раздзяляльнасць.

file fileАўдыё файл для пашырэння
denoise booleanУключыць выдаленне шуму (па змаўчанні: true)
enhance_clarity booleanПавялічыць яснасць маўлення (па змаўчанні: true)
super_resolution booleanПавысіць якасць гуку (па змаўчанні: false)
strength integer1- 3 (лёгкі, сярэдні, моцны). Па змаўчанні: 2
POST /v1/audio/separate/

Складаецца з двух частак: тэксту (тэкставая частка) і выказвання (моўная частка).

file fileАддзяліць гукавы файл
model stringdemucs (па змаўчанні) або spleeter
stems integerКолькасць ствалоў: 2, 4, 5 або 6 (па змаўчанні: 2)
format stringФармат вываду: wav, mp3, flac
POST /v1/audio/dereverb/

Выдаліць эха і рэверберацыю з аўдыёзапісаў.

file fileАпрацоўваць гукавы файл
type stringecho or reverb (default: both)
intensity integer1-5 (default: 3)
POST /v1/audio/analyze/ Свабодны

Аналіз аўдыё для выяўленьня ключоў, BPM і тактовых знакаў.

file fileАўдыёфайл для аналізу
Адказ
{
  "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/ Свабодны

Пераўтварэньне аўдыёфарматаў.

file fileАўдыё файл для пераўтварэння
format stringФармат: mp3, wav, flac, ogg, m4a, aac
bitrate integerВыходны бітрэйт у кб/ с: 64, 128, 192, 256, 320
sample_rate integerЧастата вымярэння: 22050, 44100, 48000
channels stringmono або stereo

Галасовы чатName

POST /v1/voice-chat/

Адпраўляйце аўдыё ці тэкст і атрымлівайце адказ AI з сінтэзаванай мовай.

Тэла запыту (multipart/form-data або JSON)

Параметры& Тып:Неабходны& Апісанне:
audio file Няма* Аудыа ўвод (трэба audio або text)
text string Няма* Увод тэксту (трэба audio або text)
voice string Няма Голас для адказу AI. Па змаўчанні: af_bella
tts_model string Няма Модэль TTS для адказу. Па змаўчанні: kokoro
system_prompt string Няма Нестандартная сістэмная падказка для AIName
conversation_id string Няма Працягнуць існуючую гутарку

Адказ

Адказ 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
}

Спіс мадэляў

GET /v1/models/

Верне спіс усіх даступных мадэляў з іх магчымасцямі.

Адказ

Адказ 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
    }
  ]
}

Спіс галасоў

GET /v1/voices/

Верне спіс усіх даступных галасоў з магчымасцю фільтрацыі па мадэлі або мове.

Параметры запыту

Параметры& Тып:& Апісанне:
model string Фільтраваць па ID мадэлі (напр., kokoro)
language string Фільтраваць па кодзе мовы (напр., en)
gender string Фільтр па полу: male, female, neutral

Адказ

Адказ 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
}

Прыклад коду

Пераклад тэксту на мовуName

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

Пераклад з мовы на тэкстName

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

Клонаванне голасу

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)

Пераклад тэксту на мовуName

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

Пераклад з мовы на тэкстName

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

Пераклад тэксту на мовуName

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

Пераклад з мовы на тэкстName

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"

Клонаванне голасу

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

Пашырэнне гукуName

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

Коды памылак

Усе памылкі вяртаюць адказ JSON з error Поле.

Фармат адказу на памылку
{
  "error": {
    "code": "insufficient_credits",
    "message": "You do not have enough credits for this request.",
    "credits_required": 4,
    "credits_available": 2
  }
}
Стан HTTPКод памылкі& Апісанне:
400 bad_request Недапушчальныя параметры запыту. Праверце паведамленне аб памылцы для падрабязнасцяў.
401 unauthorized Адсутнічае або няправільны ключ API.
402 insufficient_credits Нядосыць крэдытных балаў. Купляйце больш у / pricing /.
403 forbidden API доступ недаступны ў вашым плане.
404 not_found Модэль або голас не знойдзены.
413 file_too_large Памер загружанага файла перавышае абмежаванне памеру.
429 rate_limited Запытаў занадта шмат. Праверце загалоўкі абмежавання хуткасці.
500 internal_error Памылка сервера. Паспрабуйце зноў пазней.
503 model_loading Загрузка мадэлі. Паспрабуйце зноў праз некалькі секунд.

WebHooksName

Для доўгатэрміновых заданняў (раздзяленне сцябла, пакетны TTS), вы можаце даць параметр < code> webhook_ url. Калі заданне будзе завершана, мы будзем POST вынік да вашага URL.

Загрузка 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"
}
Вынікі Webhook будуць даступныя для загрузкі на працягу 24 гадзін пасля завяршэння. Упэўніцеся, што вы іх неадкладна загрузілі.

Вы гатовыя пабудаваць?

Атрымайце свой ключ API і пачніце інтэграваць TTS.ai у свае праграмы.