דלג לתוכן הראשי
Kolimina - עברית שנשמעת נכון

Kolimina Narration API

התחלה מהירה

קריינות בעברית מהמערכות שלכם, באותו תהליך של kolimina.com: אותו מילון, אותו מאגר הגייה ואותם קולות. כל קריינות היא פרויקט עם גרסאות - קובץ מלא אחד וקובץ לכל משפט - ואפשר לתקן משפט בודד בלי ליצור הכול מחדש.

  • כתובת הבסיס: https://kolimina.com/api/public/v1
  • אימות: מפתח API מלוח הבקרה (מפתחים / API), ככותרת Bearer. בצד השרת בלבד.
  • אסינכרוני: בקשות כתיבה מחזירות 202 עם עבודה (job); בודקים אותה או מקבלים Webhook.

שלושה צעדים

  1. יוצרים מפתח בלוח הבקרה ושומרים אותו בשרת שלכם כ-KOLIMINA_API_KEY.
  2. בוחרים קול: GET /voices.
  3. שולחים POST /narrations, בודקים את העבודה ומורידים את הגרסה.
cURL
# 1. Create a narration (202 + a job)
curl -s -X POST "https://kolimina.com/api/public/v1/narrations" \
  -H "Authorization: Bearer $KOLIMINA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-1001-narration" \
  -d '{"voice_id": "voice_…", "text": "שלום וברוכים הבאים. זו הקריינות הראשונה שלנו דרך ה-API."}'

# 2. Poll the job every 2–5 s (honour Retry-After) until "succeeded"
curl -s "https://kolimina.com/api/public/v1/jobs/job_…" -H "Authorization: Bearer $KOLIMINA_API_KEY"

# 3. The revision: the master file and one file per sentence
curl -s "https://kolimina.com/api/public/v1/narrations/nar_…/revisions/1" -H "Authorization: Bearer $KOLIMINA_API_KEY"
curl -s -o narration.mp3 "https://kolimina.com/api/public/v1/narrations/nar_…/revisions/1/audio" -H "Authorization: Bearer $KOLIMINA_API_KEY"

# 4. Correct one sentence (only it is re-voiced and charged; the master is rebuilt)
curl -s -X PATCH "https://kolimina.com/api/public/v1/narrations/nar_…/sentences/sent_…" \
  -H "Authorization: Bearer $KOLIMINA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-1001-fix-1" \
  -d '{"base_revision": 1, "text": "זו הקריינות הראשונה שלנו."}'

ההערות בקוד באנגלית; הפקודות זהות לתיעוד באנגלית.

המדריך המלא בעברית

האינטגרציה הראשונהאימות, יצירת קריינות, בדיקת הסטטוס והורדת השמע - מהמפתח הראשון ועד קובץ מוכן.

שאר המדריכים - תיקון משפט, תצוגה מקדימה, Webhooks, Idempotency ופתרון תקלות - וה-API reference נמצאים בתיעוד המלא באנגלית.