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" |
"5" のような文字列としての duration |
"5" |
"8" |
整数 | 8 |
"1080P", "4K" |
"1080p", "4k" のような resolution |
許可されている正確な表記 |
"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 を指定できます。
Files を参照してください。