תיעוד API

Integrate Speech to Speech AI לתוך היישומים שלך עם API מנוחה פשוטה.

התחלה מהירה

Get started with the Speech to Speech AI API in under 5 minutes.

כתובת בסיס
https://api.speechtospeechai.com/v1
1. להתחיל עבודה.

כל כלי הוא 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. סקר לתוצאה

בקש את העבודה כל כמה שניות עד שהסטטוס יושלם, ואז הורד את התוצאה.

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
Get your API key from your לוח מחוונים של חשבון.

שיכפול קול

POST /v1/voice-clone/

דבר טקסט בקול של הקלטה בהתייחסות קצרה.

מבקש גוף (multipart/form- deta)
פרמטר סוג נדרש תיאור
reference_audio file כן. הקלטה של הקול לשיבוט (10-30 שניות מומלץ, עד 60)
text string כן. טקסט לדבר בקול הזה
model string לא. פטפטן, קול פתוח, צב או ג'י.פי.טי.
language string לא. קוד שפה (ברירת מחדל: en)
תגובה

תעודת עבודה (uid). Scol Get / v1/ speech/results/?uid==/will/speak/results/?uid==/will/speak/speak/rech/reel==/speak_url===הערות שוליים==

טקסט לדיבור

POST /v1/tts/

המרת טקסט לשמיעת דיבור.

מבקש גוף (multipart/form- deta)
פרמטר סוג נדרש תיאור
text string כן. טקסט למירת (Max 5000 תווים)
model string לא. kokoro (ברירת מחדל), חלילן, vits או לנבוח
voice_id string לא. ID קול מלקבל / v1/ speech/ voices/?
language string לא. קוד שפה (ברירת מחדל: en)
speed float לא. Speed multiplier (0.5-2.0, default 1.0)
format string לא. wav (ברירת מחדל), mp3, ogg or flac. תגי SSML הוסרו לפני סינתזה.
תגובה

תעודת עבודה (uid). Scol Get / v1/ speech/results/?uid==/will/speak/results/?uid==/will/speak/speak/rech/reel==/speak_url===הערות שוליים==

נאום לטקסט

POST /v1/transcribe/

סמן אודיו לטקסט עם חותמת זמן.

מבקש גוף (multipart/form- deta)
פרמטר סוג נדרש תיאור
file file כן. קובץ שמע/ וידאו כדי לתעתק
model string לא. גדול־ V3 (ברירת מחדל) או טורבו
language string לא. קוד שפה, או אוטומטי כדי לזהות אותו (ברירת מחדל)
enable_word_timestamps bool לא. הוסף זמן התחלה וסוף לכל מילה
callback_url string לא. כתובת שמקבלת את התוצאה על ידי POST כאשר העבודה מסתיימת
תגובה

A job id (uuid). Poll GET /v1/transcribe/results/?uuid= until status is completed; the answer then carries text, language and segments.

מודלים זמינים

מודלים של טקסט לדיבור
תעודת זהות של דגם תיאור הטוב ביותר עבור
kokoro מהיר רב לשוני TTS שימוש כללי, חביון נמוך
piper TTS רב-לשוני (קולות מורשים מסחריים בלבד) מהיר מתורגם ב ־ 11 שפות
vits LJSpeech ועוד 108 דוברי אנגלית VCTK מבטא אנגלי
bark TTS Generative, 130 resets in 13 Language משלוח מפורש ושונה (איטי)
openvoice שיבוט קולי והפיכת קול אופציונלי חלופה לתיבת צ'אטר
chatterbox שיבוט קול אפס-ירייה ב-23 שפות; מודל המרת קול ברירת מחדל שיבוט מדגימה קצרה
דוגמניות מנאום אל טקסט
תעודת זהות של דגם תיאור הטוב ביותר עבור
whisper-large-v3 OpenAI Whisper Large v3 הדיוק הגבוה ביותר, רב לשוני
whisper-turbo לחישה אופטימלית למהירות תעתיק מהיר

צפנים של שגיאה

קוד מצב תיאור
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 שגיאת שרת פנימית