رفتن به محتوا
راهنمای 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 ("پارامتر ناشناخته") رد می‌شود و نزدیک‌ترین نام معتبر به‌عنوان پیشنهاد ارائه می‌شود. غلط‌های تایپی هرگز بی‌سروصدا پذیرفته نمی‌شوند.
  • صفحه هر مدل هر دو نام را در کنار هم نمایش می‌دهد.

تبدیل نوع

مقادیر به نوعی که مدل انتظار دارد تبدیل می‌شوند؛ بنابراین همه این موارد کار می‌کنند:

ارسال شما انتظار مدل تبدیل می‌شود به
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 یک فایل آپلودشده را می‌پذیرند. به فایل‌ها مراجعه کنید.