דילוג לתוכן
מדריך API

פרמטרים

הצגה כ-Markdown עודכן

כל מודל שומר על שמות הפרמטרים המקוריים שלו, וכל דף של מודל מפרט אותם. בנוסף, ה-API מקבל שמות קנוניים עבור פרמטרים שמשמעותם זהה בכל מודל, כך שקוד שנכתב עבור מודל אחד פועל גם עם המודל הבא, עם פחות שינויים.

שמות קנוניים

שם קנוני משמעות שמות מקוריים נפוצים
image תמונת הקלט או תמונת הפריים הראשון image_url, start_image_url, first_frame_url, first_image_url, source_image_url
end_image תמונת הפריים האחרון end_image_url, last_frame_url, tail_image_url
images רשימה של תמונות ייחוס image_urls, reference_image_urls
video סרטון הקלט video_url
videos רשימה של סרטוני ייחוס video_urls
audio אודיו הקלט audio_url
audios רשימה של קטעי אודיו לייחוס audio_urls
mask תמונת מסכה mask_url
num_outputs מספר התוצאות ליצירה num_images
generate_audio יצירת קול עם הסרטון generate_audio_switch, enable_audio

לאיזה שדה מקורי ממופה שם קנוני בכל אחד מהמודלים הנוכחיים:

שם קנוני שדה מקורי (מודלים שמשתמשים בו)
audio audio_url (מודלים: 126)
audios audio_urls (מודלים: 7), reference_audio_urls (מודלים: 1)
end_image end_image_url (מודלים: 76), last_frame_url (מודלים: 12), tail_image_url (מודלים: 1)
generate_audio generate_audio_switch (מודלים: 16), audio (מודלים: 3)
image image_url (מודלים: 529), start_image_url (מודלים: 20), first_frame_url (מודלים: 12), first_image_url (מודלים: 7), source_image_url (מודלים: 2)
images image_urls (מודלים: 148), reference_image_urls (מודלים: 31)
mask mask_url (מודלים: 46)
num_outputs num_images (מודלים: 337)
video video_url (מודלים: 197)
videos video_urls (מודלים: 13), reference_video_urls (מודלים: 1)

כללים:

  • יש לשלוח את השם הקנוני או את השם המקורי. אם שולחים את שניהם עם ערכים שונים, הקריאה נכשלת עם 422 invalid_input עבור השם הקנוני.
  • פרמטר שאינו שם מקורי או קנוני של המודל נדחה עם 422 invalid_input ("Unknown parameter"), בצירוף השם התקין הקרוב ביותר כהצעה. שגיאות הקלדה לעולם אינן עוברות בשקט.
  • בכל דף של מודל מוצגים שני השמות זה לצד זה.

המרת סוגים

הערכים מומרים לסוג שהמודל מצפה לו, ולכן כל האפשרויות הבאות פועלות:

מה נשלח למה המודל מצפה הופך ל-
5, "5", "5s" duration כמחרוזת כגון "5" "5"
"8" מספר שלם 8
"1080P", "4K" resolution כגון "1080p", "4k" האיות המדויק המותר
"true", "false", 1, 0 ערך בוליאני true, false
"https://…/a.jpg" רשימה של כתובות URL ["https://…/a.jpg"]
42 מחרוזת "42"

הערכים המותרים נבדקים תחילה בהתאמה מדויקת, לאחר מכן ללא תלות ברישיות, ולבסוף כמספרים (5 תואם לערכים בסגנון "5", "5s" ו-"5 s").

ברירות מחדל

פרמטרים שלא תכללו משתמשים בברירת המחדל של המודל, המפורטת בטבלת הפרמטרים של המודל. המחיר מחושב באמצעות אותן ברירות מחדל (לדוגמה, מודל וידאו שבו ברירת המחדל של generate_audio היא true מתומחר עם קול, אלא אם תשלחו "generate_audio": false).

פרמטרים של קבצים

פרמטרים של תמונה, וידאו ואודיו מקבלים כתובת URL ציבורית, URI מסוג data: בגודל של עד 10 MB, או את file_url של העלאה. ראו קבצים.