跳转到内容
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、最大 10 MB 的 data: URI,或上传文件的 file_url。 请参阅 文件。