Langkau ke kandungan
Panduan API

Parameter

Lihat sebagai Markdown Dikemas kini

Setiap model mengekalkan nama parameter natifnya, dan setiap halaman model menyenaraikannya. Selain itu, API menerima nama kanonik untuk parameter yang membawa maksud sama pada setiap model, supaya kod yang ditulis untuk satu model boleh berfungsi untuk model seterusnya dengan lebih sedikit perubahan.

Nama kanonik

Nama kanonik Maksud Nama natif yang biasa
image Imej input atau bingkai pertama image_url, start_image_url, first_frame_url, first_image_url, source_image_url
end_image Imej bingkai terakhir end_image_url, last_frame_url, tail_image_url
images Senarai imej rujukan image_urls, reference_image_urls
video Video input video_url
videos Senarai video rujukan video_urls
audio Audio input audio_url
audios Senarai klip audio rujukan audio_urls
mask Imej topeng mask_url
num_outputs Bilangan hasil yang hendak dijana num_images
generate_audio Jana bunyi bersama video generate_audio_switch, enable_audio

Medan natif yang dipetakan oleh nama kanonik pada setiap model semasa:

Nama kanonik Medan natif (model yang menggunakannya)
audio audio_url (model: 126)
audios audio_urls (model: 7), reference_audio_urls (model: 1)
end_image end_image_url (model: 76), last_frame_url (model: 12), tail_image_url (model: 1)
generate_audio generate_audio_switch (model: 16), audio (model: 3)
image image_url (model: 529), start_image_url (model: 20), first_frame_url (model: 12), first_image_url (model: 7), source_image_url (model: 2)
images image_urls (model: 148), reference_image_urls (model: 31)
mask mask_url (model: 46)
num_outputs num_images (model: 337)
video video_url (model: 197)
videos video_urls (model: 13), reference_video_urls (model: 1)

Peraturan:

  • Hantar sama ada nama kanonik atau nama natif. Jika anda menghantar kedua-duanya dengan nilai berbeza, panggilan gagal dengan 422 invalid_input pada nama kanonik.
  • Parameter yang bukan nama natif atau nama kanonik model ditolak dengan 422 invalid_input ("Unknown parameter"), bersama cadangan nama sah yang paling hampir. Kesilapan ejaan tidak akan diterima secara senyap.
  • Setiap halaman model memaparkan kedua-dua nama secara bersebelahan.

Paksaan jenis

Nilai ditukar kepada jenis yang dijangka oleh model, jadi semua ini berfungsi:

Anda hantar Model menjangka Menjadi
5, "5", "5s" duration sebagai rentetan seperti "5" "5"
"8" integer 8
"1080P", "4K" resolution seperti "1080p", "4k" ejaan tepat yang dibenarkan
"true", "false", 1, 0 boolean true, false
"https://…/a.jpg" senarai URL ["https://…/a.jpg"]
42 rentetan "42"

Nilai yang dibenarkan dipadankan dengan tepat terlebih dahulu, kemudian tanpa mengambil kira huruf besar kecil, dan akhirnya sebagai nombor (5 sepadan dengan nilai gaya "5", "5s" dan "5 s").

Nilai lalai

Parameter yang anda tinggalkan menggunakan nilai lalai model, yang disenaraikan dalam jadual parameter model. Harga dikira menggunakan nilai lalai yang sama (contohnya, model video yang generate_audio-nya lalai kepada true akan dicaj dengan bunyi melainkan anda menghantar "generate_audio": false).

Parameter fail

Parameter imej, video dan audio menerima URL awam, URI data: sehingga 10 MB, atau file_url bagi muat naik. Lihat Files.