API 指南
參數
每個模型都保留其原生參數名稱,且每個模型頁面都會列出這些名稱。此外,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、大小上限為 10 MB 的 data: URI,或上傳檔案的 file_url。
請參閱 檔案。