מפתחים

תיעוד API

כל מה שצריך כדי לבנות עם MeloLab API: אימות, קרדיטים, הפקה, משימות, webhooks וחיפוש בספרייה.

תחילת עבודה

אמתו כל בקשה עם מפתח ה-API שלכם באמצעות הכותרת Authorization: Bearer. כתובת הבסיס היא https://melolab.ai. נקודות קצה לקריאה אינן צורכות קרדיטים; יצירת הפקה משתמשת בקרדיטים הקיימים שלכם ב-MeloLab עם אותם כללי עלות והחזר כמו באפליקציית הווב. שלחו כותרת Idempotency-Key בעת יצירת הפקה כדי שניסיונות חוזרים יהיו בטוחים. תגובות מוצלחות עטופות באובייקט data; שגיאות מחזירות code, message ו-request_id.

חשבון

קראו את פרופיל ה-API שלכם, יתרת הקרדיטים והשימוש האחרון.

GET/api/v1/meprofile:read

מחזיר את פרופיל ה-API המאומת, כולל דרגת החשבון וזמינות ה-API.

curl -X GET https://melolab.ai/api/v1/me \
  -H "Authorization: Bearer $MELOLAB_API_KEY"
GET/api/v1/creditscredits:read

מחזיר את יתרת הקרדיטים הקיימת שלכם ב-MeloLab. אינו צורך קרדיטים.

curl -X GET https://melolab.ai/api/v1/credits \
  -H "Authorization: Bearer $MELOLAB_API_KEY"
GET/api/v1/usageprofile:read

מחזיר סיכום שימוש ואירועי בקשות אחרונים לאחר הסתרת מידע רגיש.

curl -X GET https://melolab.ai/api/v1/usage \
  -H "Authorization: Bearer $MELOLAB_API_KEY"

מודלים

הציגו את מודלי MeloLab הזמינים ואת עלותם בקרדיטים.

GET/api/v1/modelsmodels:read

מציג את מודלי MeloLab הזמינים ואת עלותם בקרדיטים.

curl -X GET https://melolab.ai/api/v1/models \
  -H "Authorization: Bearer $MELOLAB_API_KEY"
GET/api/v1/models/{model_id}models:read

מחזיר מודל יחיד לפי id.

curl -X GET https://melolab.ai/api/v1/models/suno/v5-5 \
  -H "Authorization: Bearer $MELOLAB_API_KEY"

הפקות

צרו הפקת מוזיקה, הציגו הפקות אחרונות, ותשאלו משימה עד לסיומה.

POST/api/v1/generationsgenerations:create

יוצר הפקת מוזיקה אסינכרונית. משתמש בקרדיטים הקיימים שלכם ב-MeloLab; דורש כותרת Idempotency-Key.

curl -X POST https://melolab.ai/api/v1/generations \
  -H "Authorization: Bearer $MELOLAB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model_id":"suno/v5-5","prompt":"warm lofi beat for a focus playlist"}'
GET/api/v1/generationsgenerations:read

מציג את משימות ההפקה האחרונות שלכם.

curl -X GET https://melolab.ai/api/v1/generations \
  -H "Authorization: Bearer $MELOLAB_API_KEY"
GET/api/v1/generations/{id}generations:read

מתשאל הפקה ומחזיר את הרצועות שלה עם השלמתה.

curl -X GET https://melolab.ai/api/v1/generations/gen_123 \
  -H "Authorization: Bearer $MELOLAB_API_KEY"
GET/api/v1/jobs/{job_id}

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

curl -X GET https://melolab.ai/api/v1/jobs/job_123 \
  -H "Authorization: Bearer $MELOLAB_API_KEY"

ספרייה

חפשו רצועות ופלייליסטים הניתנים לנגינה, וקראו פרטים של רצועות או פלייליסטים בודדים.

GET/api/v1/library/searchlibrary:read

מחפש רצועות ופלייליסטים הניתנים לנגינה, כולל הפריטים הפרטיים שלכם.

curl -X GET https://melolab.ai/api/v1/library/search?q=lofi \
  -H "Authorization: Bearer $MELOLAB_API_KEY"
GET/api/v1/tracks/{id}library:read

מחזיר מטא-נתונים הניתנים לנגינה עבור רצועה.

curl -X GET https://melolab.ai/api/v1/tracks/track_123 \
  -H "Authorization: Bearer $MELOLAB_API_KEY"
GET/api/v1/playlistslibrary:read

מציג את הפלייליסטים הזמינים לכם.

curl -X GET https://melolab.ai/api/v1/playlists \
  -H "Authorization: Bearer $MELOLAB_API_KEY"
GET/api/v1/playlists/{id}library:read

מחזיר פלייליסט ואת הרצועות שלו.

curl -X GET https://melolab.ai/api/v1/playlists/playlist_123 \
  -H "Authorization: Bearer $MELOLAB_API_KEY"

Webhooks

רשמו נקודות קצה של HTTPS כדי לקבל התראה כשמשימות אסינכרוניות מסתיימות, בלי צורך בתשאול. סוד החתימה המלא מוצג פעם אחת בלבד בעת יצירת נקודת קצה.

GET/api/v1/webhook-endpoints

מציג את נקודות הקצה הפעילות של ה-webhook שלכם.

curl -X GET https://melolab.ai/api/v1/webhook-endpoints \
  -H "Authorization: Bearer $MELOLAB_API_KEY"
POST/api/v1/webhook-endpoints

רושם נקודת קצה ציבורית של webhook ב-HTTPS. סוד החתימה מוחזר פעם אחת בלבד.

curl -X POST https://melolab.ai/api/v1/webhook-endpoints \
  -H "Authorization: Bearer $MELOLAB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/melolab/webhook"}'
PATCH/api/v1/webhook-endpoints/{id}

מעדכן את כתובת ה-URL או הסטטוס של נקודת קצה של webhook.

curl -X PATCH https://melolab.ai/api/v1/webhook-endpoints/wh_123 \
  -H "Authorization: Bearer $MELOLAB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"disabled"}'
DELETE/api/v1/webhook-endpoints/{id}

מוחק נקודת קצה של webhook.

curl -X DELETE https://melolab.ai/api/v1/webhook-endpoints/wh_123 \
  -H "Authorization: Bearer $MELOLAB_API_KEY"

יומנים

עיינו ביומני בקשות ה-API מ-30 הימים האחרונים.

GET/api/v1/logs

מציג את יומני בקשות ה-API מ-30 הימים האחרונים.

curl -X GET https://melolab.ai/api/v1/logs?limit=20 \
  -H "Authorization: Bearer $MELOLAB_API_KEY"

מגבלות קצב

נקודות קצה לקריאה מאפשרות 600 בקשות לדקה (50,000 ליום). הפקת מוזיקה מאפשרת 12 בקשות לדקה (500 ליום). האימות מוגבל ל-120 בקשות לדקה לכל כתובת IP. חריגה ממגבלה מחזירה 429 rate_limited.

שגיאות

שגיאות מחזירות סטטוס HTTP וכן גוף JSON { error: { code, message, request_id } }. צרפו את request_id כשאתם פונים לתמיכה.

סטטוסקודמשמעות
401authentication_requiredלא סופק מפתח API בכותרת Authorization.
401invalid_api_keyמפתח ה-API אינו תקין או בוטל.
403insufficient_scopeלמפתח ה-API חסר היקף הרשאה נדרש.
400invalid_requestגוף הבקשה או הפרמטרים אינם תקינים.
400invalid_modelמזהה הדגם המבוקש אינו קיים.
402insufficient_creditsאין מספיק קרדיטים של MeloLab כדי ליצור הפקה זו.
409idempotency_conflictה-Idempotency-Key נעשה בו שימוש חוזר עם גוף בקשה שונה.
404not_foundהמשאב המבוקש לא נמצא או שאינו שלכם.
429rate_limitedיותר מדי בקשות; האטו ונסו שוב מאוחר יותר.
502provider_unavailableהספק במעלה הזרם אינו זמין באופן זמני.

להתחיל בחינם

אין צורך בכרטיס אשראי. מתחילים תוך שניות.