مستندات API

Integrate Speech to Speech AI into your applications with a simple REST API.

آغاز سریع

با API Speech to Speech AI در کمتر از ۵ دقیقه شروع کنید.

نشانی وب پایه
https://api.speechtospeechai.com/v1
1. Start a job

هر ابزار POST با کلید API شماست. پاسخ یک شناسه کار است، نه صدا.

cURL
curl -X POST https://api.speechtospeechai.com/v1/tts/ \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "text=Hello! Welcome to Speech to Speech AI." \
  -F "model=kokoro" \
  -F "voice_id=af_heart" \
  -F "format=mp3"

{"uuid": "3f2c...", "job_id": "...", "status": "queued"}
2. نظرسنجی برای نتیجه

هر چند ثانیه یک بار وظیفه را درخواست کنید تا وضعیت کامل شود، سپس URL نتیجه را دانلود کنید.

cURL
curl "https://api.speechtospeechai.com/v1/speech/results/?uuid=3f2c..." \
  -H "Authorization: Bearer YOUR_API_KEY"

{"status": "completed", "result_url": "https://.../output.mp3"}

احراز هویت

تمام درخواست‌های API نیازمند احراز هویت از طریق یک کلید API در Authorization سري

سرآیند
Authorization: Bearer YOUR_API_KEY
کلید API خود را از صفحه نمایش حساب.

شبیه‌سازی صدا

POST /v1/voice-clone/

یک متن را با صدای یک ضبط مرجع کوتاه بگویید.

بدنۀ درخواست) چندبخشی/داده‌های فرم (
پارامتر نوع لازم توصیف
reference_audio file آره ضبط صدا برای شبیه‌سازی (۱۰-۳۰ ثانیه توصیه می‌شود، تا ۶۰)
text string آره متنی که با آن صدا صحبت خواهد شد
model string نه chatterbox، openvoice، tortoise یا gpt-sovits
language string نه کد زبان) پیش‌فرض: en (
پاسخ

یک شناسه کار (uuid). تا زمانی که وضعیت تکمیل شود و URL نتیجه را دانلود کنید، پرس و جو GET /v1/speech/results/?uuid= را انجام دهید.

متن به گفتار

POST /v1/tts/

تبدیل متن به صدای گفتار.

بدنۀ درخواست) چندبخشی/داده‌های فرم (
پارامتر نوع لازم توصیف
text string آره متن برای تبدیل) حداکثر ۵۰۰۰ نویسه (
model string نه kokoro (پیش‌فرض)، piper، vits یا bark
voice_id string نه شناسه صدا از GET /v1/speech/voices/?model=
language string نه کد زبان) پیش‌فرض: en (
speed float نه Speed multiplier (0.5-2.0, default 1.0)
format string نه wav (قبل‌فرض)، mp3 ، ogg یا flac. برچسب‌های SSML قبل از ترکیب حذف می‌شوند.
پاسخ

یک شناسه کار (uuid). تا زمانی که وضعیت تکمیل شود و URL نتیجه را دانلود کنید، پرس و جو GET /v1/speech/results/?uuid= را انجام دهید.

تبدیل گفتار به متن

POST /v1/transcribe/

رونوشت صدا به متن با علامت زمان.

بدنۀ درخواست) چندبخشی/داده‌های فرم (
پارامتر نوع لازم توصیف
file file آره پروندۀ صوتی/ویدئویی برای رونوشت
model string نه بزرگ- v3) پیش‌فرض (یا توربو
language string نه کد زبان ، یا تشخیص خودکار آن) پیش‌فرض (
enable_word_timestamps bool نه افزودن زمان آغاز و پایان به هر کلمه
callback_url string نه نشانی وب که هنگام پایان کار، با POST نتیجه را دریافت می‌کند
پاسخ

یک شناسه کار (uuid). پرس و جو GET /v1/transcribe/results/?uuid= تا زمانی که وضعیت تکمیل شود؛ پاسخ پس از آن متن، زبان و بخش‌ها را حمل می‌کند.

مدلهای موجود

مدل‌های متن به گفتار
شناسۀ مدل توصیف بهترین برای
kokoro TTS سریع چندزبانه کاربرد عمومی ، تأخیر کم
piper TTS چندزبانه سبک وزن (تنها صداهای مجوزدار تجاری) رندرهای سریع در ۱۱ زبان
vits LJSpeech plus 108 VCTK انگلیسی زبانان لهجه انگلیسی
bark TTS تولیدکننده، ۱۳۰ پیش‌فرض در ۱۳ زبان ارائه متنوع و بیانگر) آهسته (
openvoice شبیه‌سازی صدا و تبدیل گزینشی صدا جایگزین برای Chatterbox
chatterbox شبیه‌سازی صدای Zero-shot در ۲۳ زبان؛ مدل پیش‌فرض تبدیل صدا شبیه‌سازی از نمونه کوتاه
مدل‌های گفتار به متن
شناسۀ مدل توصیف بهترین برای
whisper-large-v3 OpenAI Whisper Large v3 بالاترین دقت، چندزبانه
whisper-turbo Whisper برای سرعت بهینه شده رونوشت سریع

کدهای خطا

کد وضعیت توصیف
invalid_api_key 401 کلید API نامعتبر یا گمشده
insufficient_credits 402 اعتبار کافی برای این عملیات وجود ندارد
rate_limit_exceeded 429 درخواست‌های زیادی وجود دارد
invalid_request 400 بدنۀ درخواست نامنظم
model_not_found 404 مدل درخواست شده وجود ندارد
voice_not_found 404 صدای درخواست شده وجود ندارد
file_too_large 413 پروندۀ بارگذاری‌شده از حد اندازه تجاوز می‌کند
server_error 500 خطای کارساز داخلی