All checks were successful
Build and Deploy / build-and-deploy (push) Successful in 5m38s
- 新增 4 个火山官方 API 文档(Seedance 2.0 1080P / seedance 模型价格 / seedance 2.0 系列教程 / 创建视频生成任务API) - 归档 6 个过期文档到 docs/archive/(旧 Seedance API 邀测版 / 旧 Assets API 邀测版 / celery 轮询修复 / design-review / prd / test-report) - 新增 docs/todo/ 目录(提示词 AI 优化功能待办) - changelog.md 补 v0.18.3 条目 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
649 lines
28 KiB
Markdown
649 lines
28 KiB
Markdown
`POST https://ark.cn-beijing.volces.com/api/v3/contents/generations/tasks` [ ](https://api.volcengine.com/api-explorer/?action=CreateContentsGenerationsTasks&data=%7B%7D&groupName=%E8%A7%86%E9%A2%91%E7%94%9F%E6%88%90API&query=%7B%7D&serviceCode=ark&version=2024-01-01)[运行](https://api.volcengine.com/api-explorer/?action=CreateContentsGenerationsTasks&data=%7B%7D&groupName=%E8%A7%86%E9%A2%91%E7%94%9F%E6%88%90API&query=%7B%7D&serviceCode=ark&version=2024-01-01)
|
||
本文介绍创建视频生成任务 API 的输入输出参数,供您使用接口时查阅字段含义。模型会依据传入的图片及文本信息生成视频,待生成完成后,您可以按条件查询任务并获取生成的视频。
|
||
:::tip
|
||
请确保您的账户余额大于等于 200 元([前往充值](https://console.volcengine.com/finance/fund/recharge)),或已[购买资源包](https://console.volcengine.com/common-buy/fast/ark_bd%7C%7Cd682ppeeq1mp7kd5q0e0),否则无法开通 seedance 2.0 及 seedance 2.0 fast 模型。
|
||
|
||
:::
|
||
**模型能力==^new^==**
|
||
|
||
* **seedance 2.0 & 2.0 fast==^new^==** ** (有声视频/无声视频)**
|
||
* **多模态参考生视频==^new^==**:输入++参考图片(0~9)+参考视频(0~3)+ 参考音频(0~3)+ 文本提示词(可选)++ 生成 1 个目标视频。注意不可单独输入音频,应至少包含 1 个参考视频或图片。支持生成全新视频、编辑视频、延长视频,[阅读教程](https://www.volcengine.com/docs/82379/2291680) 获取详细代码示例。
|
||
* **图生视频\-首尾帧**:输入++首帧图片+尾帧图片+文本提示词(可选)++ 生成 1 个目标视频。
|
||
* **图生视频\-首帧**:输入++首帧图片+文本提示词(可选)++ 生成 1 个目标视频。
|
||
* **文生视频**:输入++文本提示词++生成 1 个目标视频。
|
||
* **seedance 1.5 pro (有声视频/无声视频)**
|
||
【图生视频\-首尾帧】【图生视频\-首帧】【文生视频】
|
||
* **seedance 1.0 pro**
|
||
【图生视频\-首尾帧】【图生视频\-首帧】【文生视频】
|
||
* **seedance 1.0 pro fast**
|
||
【图生视频\-首帧】【文生视频】
|
||
* **seedance 1.0 lite**
|
||
* **doubao\-seedance\-1\-0\-lite\-t2v:** 文生视频
|
||
* **doubao\-seedance\-1\-0\-lite\-i2v:**
|
||
* 参考图生视频:根据您输入的**++参考图片(1\-4张)++ ** +++文本提示词(可选)++ 生成 1 个目标视频。
|
||
* 图生视频\-首尾帧
|
||
* 图生视频\-首帧
|
||
|
||
|
||
Tips:一键展开折叠,快速检索内容
|
||
打开页面右上角开关,**ctrl ** + **f** 可检索页面内所有内容。
|
||
<span> </span>
|
||
|
||
|
||
```mixin-react
|
||
return (<Tabs>
|
||
<Tabs.TabPane title="在线调试" key="4rK5FhUg"><RenderMd content={`<APILink link="https://api.volcengine.com/api-explorer/?action=CreateContentsGenerationsTasks&data=%7B%7D&groupName=%E8%A7%86%E9%A2%91%E7%94%9F%E6%88%90API&query=%7B%7D&serviceCode=ark&version=2024-01-01" description="API Explorer 您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。"></APILink>
|
||
`}></RenderMd></Tabs.TabPane>
|
||
<Tabs.TabPane title="鉴权说明" key="iRuPtuk6"><RenderMd content={`本接口仅支持 API Key 鉴权,请在 [获取 API Key](https://console.volcengine.com/ark/region:ark+cn-beijing/apiKey) 页面,获取长效 API Key。
|
||
`}></RenderMd></Tabs.TabPane>
|
||
<Tabs.TabPane title="快速入口" key="5LZLMN0J"><RenderMd content={` [ ](#)[体验中心](https://console.volcengine.com/ark/region:ark+cn-beijing/experience/vision) <span> </span>[模型列表](https://www.volcengine.com/docs/82379/1330310?lang=zh#2705b333) <span> </span>[模型计费](https://www.volcengine.com/docs/82379/1544106?redirect=1&lang=zh#02affcb8) <span> </span>[API Key](https://console.volcengine.com/ark/region:ark+cn-beijing/apiKey?apikey=%7B%7D)
|
||
<span> </span>[调用教程](https://www.volcengine.com/docs/82379/1366799) <span> </span>[接口文档](https://www.volcengine.com/docs/82379/1520758) <span> </span>[常见问题](https://www.volcengine.com/docs/82379/1359411) <span> </span>[开通模型](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement?LLM=%7B%7D&OpenTokenDrawer=false)
|
||
`}></RenderMd></Tabs.TabPane></Tabs>);
|
||
```
|
||
|
||
|
||
---
|
||
|
||
|
||
<span id="5qndT7DS"></span>
|
||
## 请求参数
|
||
> 跳转 [响应参数](#y2hhTyHB)
|
||
|
||
<span id="wsGzv1pD"></span>
|
||
### 请求体
|
||
|
||
---
|
||
|
||
|
||
**model** `string` %%require%%
|
||
您需要调用的模型的 ID (Model ID),[开通模型服务](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement?LLM=%7B%7D&OpenTokenDrawer=false),并[查询 Model ID](https://www.volcengine.com/docs/82379/1330310) 。
|
||
您也可通过 Endpoint ID 来调用模型,获得限流、计费类型(前付费/后付费)、运行状态查询、监控、安全等高级能力,可参考[获取 Endpoint ID](https://www.volcengine.com/docs/82379/1099522)。
|
||
|
||
---
|
||
|
||
|
||
**content** `object[]` %%require%%
|
||
输入给模型,生成视频的信息,支持文本、图片、音频、视频、样片任务 ID。
|
||
:::warning
|
||
seedance 2.0 系列模型不支持直接上传含有真人人脸的参考图/视频。为了便利创作者对肖像的使用,平台推出了以下解决方案,详情参见 [教程](https://www.volcengine.com/docs/82379/2291680?lang=zh#5c67c9a1)。
|
||
|
||
* 支持使用部分模型的含人脸原始产物作为输入素材
|
||
* 支持使用预置虚拟人像作为输入素材
|
||
* 支持使用已授权真人素材作为输入
|
||
|
||
:::
|
||
支持以下几种组合:
|
||
|
||
* **文本**
|
||
* **文本(可选)+ 图片**
|
||
* **文本(可选)+ 视频**
|
||
* **文本(可选)+ 图片 + 音频**
|
||
* **文本(可选)+ 图片 + 视频**
|
||
* **文本(可选)+ 视频 + 音频**
|
||
* **文本(可选)+ 图片 + 视频 + 音频**
|
||
* **样片任务 ID**:样片指使用 seedance 模型成功生成的样片视频,模型可基于样片生成高质量正式视频。
|
||
|
||
|
||
信息类型
|
||
|
||
---
|
||
|
||
|
||
**文本信息** `object`
|
||
输入给模型的提示词信息。
|
||
|
||
属性
|
||
|
||
---
|
||
|
||
|
||
content.**type ** `string` %%require%%
|
||
输入内容的类型,此处应为 `text`。
|
||
|
||
---
|
||
|
||
|
||
content.**text ** `string` %%require%%
|
||
输入给模型的文本提示词,描述期望生成的视频。
|
||
:::tip
|
||
|
||
* 提示词语言支持:所有模型均支持中英文提示词;seedance 2.0 及 seedance 2.0 fast 额外支持日语、印尼语、西班牙语、葡萄牙语。
|
||
* 提示词字数建议:中文提示词不超过500字,英文提示词不超过1000词。字数过多易导致信息分散,模型可能忽略细节、仅关注重点,进而造成视频缺失部分元素。
|
||
* 更多使用技巧:提示词的详细使用技巧,请参见 [seedance 提示词指南](https://www.volcengine.com/docs/82379/2222480?lang=zh)。
|
||
|
||
|
||
|
||
:::
|
||
|
||
---
|
||
|
||
|
||
**图片信息==^new^==** `object`
|
||
输入给模型的图片信息。
|
||
|
||
属性
|
||
|
||
---
|
||
|
||
|
||
content.**type ** `string` %%require%%
|
||
输入内容的类型,此处应为 `image_url`。
|
||
|
||
---
|
||
|
||
|
||
content.**image_url ** `object` %%require%%
|
||
输入给模型的图片对象。
|
||
|
||
属性
|
||
|
||
---
|
||
|
||
|
||
content.image_url.**url ** `string` %%require%%
|
||
图片 URL 、图片 Base64 编码、素材 ID。
|
||
|
||
* 图片 URL:填入图片的公网 URL。
|
||
* Base64 编码:将本地文件转换为 Base64 编码字符串,然后提交给大模型。遵循格式:`data:image/<图片格式>;base64,<Base64编码>`,注意 `<图片格式>` 需小写,如 `data:image/png;base64,{base64_image}`。
|
||
* 素材 ID:用于视频生成的预置素材及虚拟人像的 ID,遵循格式:asset://<ASSET_ID\>。可从 [素材&虚拟人像库](https://console.volcengine.com/ark/region:ark+cn-beijing/experience/vision?modelId=doubao-seedance-2-0-260128) 获取。
|
||
|
||
:::tip 传入单张图片要求
|
||
|
||
* 格式:jpeg、png、webp、bmp、tiff、gif。其中,seedance 1.5 pro 新增支持 heic 和 heif。
|
||
* 宽高比(宽/高): (0.4, 2.5)
|
||
* 宽高长度(px):(300, 6000)
|
||
* 大小:单张图片小于 30 MB。请求体大小不超过 64 MB。大文件请勿使用Base64编码。
|
||
* 图片数量:
|
||
* 图生视频\-首帧:1 张
|
||
* 图生视频\-首尾帧:2 张
|
||
* seedance 2.0&2.0 fast 多模态参考生视频:1~9 张
|
||
* seedance 1.0 lite 参考图生视频:1~4 张
|
||
|
||
:::
|
||
|
||
---
|
||
|
||
|
||
content.**role ** `string` `条件必填`
|
||
图片的位置或用途。
|
||
:::warning
|
||
|
||
* **图生视频\-首帧**、**图生视频\-首尾帧**、**多模态参考生视频**(包括参考图、视频、音频)为 3 种互斥场景,**不可混用**。
|
||
* **多模态参考生视频**可通过提示词指定参考图片作为首帧/尾帧,间接实现“首尾帧+多模态参考”效果。若需严格保障首尾帧和指定图片一致,**优先使用图生视频\-首尾帧**(配置 role 为 first_frame/last_frame)。
|
||
|
||
|
||
:::
|
||
图生视频\-首帧
|
||
|
||
* **支持模型:** 所有图生视频模型
|
||
* **字段role取值:** 需要传入1个 image_url 对象,字段 role 为 first_frame 或不填。
|
||
|
||
|
||
图生视频\-首尾帧
|
||
|
||
* **支持模型:** seedance 2.0 & 2.0 fast,seedance 1.5 pro、seedance 1.0 pro、seedance 1.0 lite i2v
|
||
* **字段role取值:** 需要传入2个image_url对象,且字段 role 必填。
|
||
* 首帧图片对应的字段 role 为:first_frame
|
||
* 尾帧图片对应的字段 role 为:last_frame
|
||
|
||
:::tip
|
||
传入的首尾帧图片可相同。首尾帧图片的宽高比不一致时,以首帧图片为主,尾帧图片会自动裁剪适配。
|
||
|
||
:::
|
||
|
||
图生视频\-参考图
|
||
|
||
* **支持模型:** seedance 2.0 & 2.0 fast(1~9 张图片),seedance 1.0 lite i2v(1~4 张图片)
|
||
* **字段role取值:** 必填,每张参考图对应的字段 role 均为:reference_image
|
||
|
||
:::tip
|
||
参考图生视频功能的文本提示词,可以用自然语言指定多张图片的组合。但若想有更好的指令遵循效果,**推荐使用“[图1]xxx,[图2]xxx”的方式来指定图片**。
|
||
示例1:戴着眼镜穿着蓝色T恤的男生和柯基小狗,坐在草坪上,3D卡通风格
|
||
示例2:[图1]戴着眼镜穿着蓝色T恤的男生和[图2]的柯基小狗,坐在[图3]的草坪上,3D卡通风格
|
||
|
||
:::
|
||
|
||
|
||
---
|
||
|
||
|
||
**视频信息==^new^==** `object`
|
||
输入给模型的视频信息。仅 seedance 2.0 & 2.0 fast 支持输入视频。
|
||
方舟平台信任 seedance 2.0 及 2.0 fast 模型生成的含人脸视频,您可使用**本账号下近30天内由上述模型生成的含人脸原始视频**,作为输入素材进行二次创作,详情参见 [教程](https://www.volcengine.com/docs/82379/2291680?lang=zh#86c3831f)。
|
||
|
||
属性
|
||
content.**type ** `string` %%require%%
|
||
输入内容的类型,此处应为`video_url`。
|
||
|
||
---
|
||
|
||
|
||
content.**video_url** ** ** `object` %%require%%
|
||
输入给模型的视频对象。
|
||
|
||
属性
|
||
content.video_url.**url ** `string` %%require%%
|
||
视频URL、素材 ID。
|
||
|
||
* 视频 URL:填入视频的公网 URL。
|
||
* 素材 ID:用于视频生成的预置素材及虚拟人像视频的 ID,遵循格式:asset://<ASSET_ID\>。可从[素材&虚拟人像库](https://console.volcengine.com/ark/region:ark+cn-beijing/experience/vision?modelId=doubao-seedance-2-0-260128)获取。
|
||
|
||
:::tip 传入单个视频要求
|
||
|
||
* 视频格式:mp4、mov,支持编码格式见下表。
|
||
* 分辨率:480p,720p,1080p
|
||
* 时长:单个视频时长 [2, 15] s,最多传入 3 个参考视频,所有视频总时长不超过 15s。
|
||
* 尺寸:
|
||
* 宽高比(宽/高):[0.4, 2.5]
|
||
* 宽高长度(px):[300, 6000]
|
||
* 总像素数:[640×640=409600, 2206×946=2086876],即宽和高的乘积符合 [409600, 2086876] 的区间要求。
|
||
* 大小:单个视频不超过 50 MB。
|
||
* 帧率 (FPS):[24, 60]
|
||
|
||
:::
|
||
|
||
---
|
||
|
||
|
||
content.**role ** `string` `条件必填`
|
||
视频的位置或用途。当前仅支持 reference_video:参考视频。
|
||
|
||
|
||
---
|
||
|
||
|
||
**音频信息==^new^==** `object`
|
||
输入给模型的音频信息。仅 seedance 2.0&2.0 fast 支持输入音频。
|
||
注意不可单独输入音频,应至少包含 1 个参考视频或图片。
|
||
|
||
属性
|
||
content.**type ** `string` %%require%%
|
||
输入内容的类型,此处应为`audio_url`。
|
||
|
||
---
|
||
|
||
|
||
content.**audio_url** ** ** `object` %%require%%
|
||
输入给模型的音频对象。
|
||
|
||
属性
|
||
content.audio_url.**url ** `string` %%require%%
|
||
音频 URL 、音频 Base64 编码、素材 ID。
|
||
|
||
* 音频 URL:填入音频的公网 URL。
|
||
* Base64 编码:将本地文件转换为 Base64 编码字符串,然后提交给大模型。遵循格式:`data:audio/<音频格式>;base64,<Base64编码>`,注意 `<音频格式>` 需小写,如 `data:audio/wav;base64,{base64_audio}`。
|
||
* 素材 ID:用于视频生成的虚拟人的音频素材 ID,遵循格式:asset://<ASSET_ID\>。可从[素材&虚拟人像库](https://console.volcengine.com/ark/region:ark+cn-beijing/experience/vision?modelId=doubao-seedance-2-0-260128)获取。
|
||
|
||
:::tip 传入单个音频要求
|
||
|
||
* 格式:wav、mp3
|
||
* 时长:单个音频时长 [2, 15] s,最多传入 3 段参考音频,所有音频总时长不超过 15 s。
|
||
* 大小:单个音频不超过 15 MB,请求体大小不超过 64 MB。大文件请勿使用Base64编码。
|
||
|
||
|
||
|
||
:::
|
||
|
||
---
|
||
|
||
|
||
content.**role ** `string` `条件必填`
|
||
音频的位置或用途。当前仅支持 reference_audio:参考音频。
|
||
|
||
|
||
|
||
---
|
||
|
||
|
||
**样片信息 ** `object`
|
||
基于样片任务 ID,生成正式视频。仅 seedance 1.5 pro 支持该功能。[阅读](https://www.volcengine.com/docs/82379/1366799?lang=zh#5acd28c8)[文档](https://www.volcengine.com/docs/82379/1366799?lang=zh#5acd28c8) 获取 draft 功能的使用教程和注意事项。
|
||
|
||
属性
|
||
|
||
---
|
||
|
||
|
||
content.**type ** `string` %%require%%
|
||
输入内容的类型,此处应为 `draft_task`。
|
||
|
||
---
|
||
|
||
|
||
content.**draft_task** ** ** `object` %%require%%
|
||
输入给模型的样片任务。
|
||
|
||
属性
|
||
|
||
---
|
||
|
||
|
||
content.draft_task.**id ** `string` %%require%%
|
||
样片任务 ID。平台将自动复用 Draft 视频使用的用户输入(**model、** content.**text、** content.**image_url、generate_audio、seed、ratio、duration、camera_fixed ** ),生成正式视频。其余参数支持指定,不指定将使用本模型的默认值。
|
||
使用分为两步:Step1: 调用本接口生成 Draft 视频。Step2: 如果确认 Draft 视频符合预期,可基于 Step1 返回的 Draft 视频任务 ID,调用本接口生成最终视频。[阅读文档](https://www.volcengine.com/docs/82379/1366799?lang=zh#5acd28c8) 获取详细教程。
|
||
|
||
|
||
|
||
|
||
---
|
||
|
||
|
||
**callback_url** `string`
|
||
填写本次生成任务结果的回调通知地址。当视频生成任务有状态变化时,方舟将向此地址推送 POST 请求。
|
||
回调请求内容结构与[查询任务API](https://www.volcengine.com/docs/82379/1521309)的返回体一致。
|
||
回调返回的 status 包括以下状态:
|
||
|
||
* queued:排队中。
|
||
* running:任务运行中。
|
||
* succeeded: 任务成功。(如发送失败,即5秒内没有接收到成功发送的信息,回调三次)
|
||
* failed:任务失败。(如发送失败,即5秒内没有接收到成功发送的信息,回调三次)
|
||
* expired:任务超时,即任务处于**运行中或排队中**状态超过过期时间。可通过 **execution_expires_after ** 字段设置过期时间。
|
||
|
||
|
||
---
|
||
|
||
|
||
**return_last_frame** `boolean` `默认值 false`
|
||
|
||
* true:返回生成视频的尾帧图像。设置为 `true` 后,可通过 [查询视频生成任务接口](https://www.volcengine.com/docs/82379/1521309) 获取视频的尾帧图像。尾帧图像的格式为 png,宽高像素值与生成的视频保持一致,无水印。
|
||
使用该参数可实现生成多个连续视频:以上一个生成视频的尾帧作为下一个视频任务的首帧,快速生成多个连续视频,调用示例详见 [教程](https://www.volcengine.com/docs/82379/1366799?lang=zh#141cf7fa)。
|
||
* false:不返回生成视频的尾帧图像。
|
||
|
||
|
||
---
|
||
|
||
|
||
**service_tier** `string` `默认值 default`
|
||
> 不支持修改已提交任务的服务等级
|
||
> seedance 2.0 & 2.0 fast 不支持离线推理
|
||
|
||
指定处理本次请求的服务等级类型,枚举值:
|
||
|
||
* default:在线推理模式,RPM 和并发数配额较低(详见 [模型列表](https://www.volcengine.com/docs/82379/1330310?lang=zh#2705b333)),适合对推理时效性要求较高的场景。
|
||
* flex:离线推理模式,TPD 配额更高(详见 [模型列表](https://www.volcengine.com/docs/82379/1330310?lang=zh#2705b333)),价格为在线推理的 50%, 适合对推理时延要求不高的场景。
|
||
|
||
|
||
---
|
||
|
||
|
||
**execution_expires_after ** `integer` `默认值 172800`
|
||
任务超时阈值。指定任务提交后的过期时间(单位:秒),从 **created at** 时间戳开始计算。默认值 172800 秒,即 48 小时。取值范围:[3600,259200]。
|
||
不论使用哪种 **service_tier**,都建议根据业务场景设置合适的超时时间。超过该时间后任务会被自动终止,并标记为`expired`状态。
|
||
|
||
---
|
||
|
||
|
||
**generate_audio ** `boolean` `默认值 true`
|
||
> 仅 seedance 2.0 & 2.0 fast、seedance 1.5 pro 支持
|
||
|
||
控制生成的视频是否包含与画面同步的声音。
|
||
|
||
* true:模型输出的视频包含同步音频。模型会基于文本提示词与视觉内容,自动生成与之匹配的人声、音效及背景音乐。建议将对话部分置于双引号内,以优化音频生成效果。例如:男人叫住女人说:“你记住,以后不可以用手指指月亮。”
|
||
* false:模型输出的视频为无声视频。
|
||
|
||
:::warning
|
||
生成的有声视频均为单声道,和传入的音频声道数无关。
|
||
|
||
:::
|
||
---
|
||
|
||
|
||
**draft ** `boolean` `默认值 false`
|
||
> 仅 seedance 1.5 pro 支持
|
||
|
||
控制是否开启样片模式。[阅读文档](https://www.volcengine.com/docs/82379/1366799?lang=zh#5acd28c8) 获取使用教程和注意事项。
|
||
|
||
* true:开启样片模式,生成一段预览视频,快速验证场景结构、镜头调度、主体动作与 prompt 意图是否符合预期。消耗 token 数较正常视频更少,使用成本更低。
|
||
* false:关闭样片模式,正常生成一段视频。
|
||
|
||
:::tip
|
||
开启样片模式后,将使用 480p 分辨率生成 Draft 视频(使用其他分辨率会报错),不支持返回尾帧功能,不支持离线推理功能。
|
||
|
||
:::
|
||
---
|
||
|
||
|
||
**tools==^new^==** ** ** `object[]`
|
||
> 仅 seedance 2.0 & 2.0 fast 支持
|
||
|
||
配置模型要调用的工具。
|
||
|
||
属性
|
||
tools.**type ** `string`
|
||
指定使用的工具类型。
|
||
|
||
* web_search:联网搜索工具。[阅读教程](https://www.volcengine.com/docs/82379/1366799?lang=zh#c40ed3ef) 获取详细代码示例。
|
||
|
||
:::tip
|
||
|
||
* 开启联网搜索后,模型会根据用户的提示词自主判断是否搜索互联网内容(如商品、天气等)。可提升生成视频的时效性,但也会增加一定的时延。
|
||
* 实际搜索次数可通过 [查询视频生成任务 API](https://www.volcengine.com/docs/82379/1521309?lang=zh) 返回的 usage.tool_usage.**web_search** 字段获取,如果为 0 表示未搜索。
|
||
|
||
:::
|
||
|
||
---
|
||
|
||
|
||
**safety_identifier==^new^==** `string`
|
||
终端用户的唯一标识符,用于协助平台检测您的应用中可能违反火山方舟使用政策的用户。该标识符为英文字符串,需保证对单个用户固定且唯一,长度不超过 64 个字符。推荐传入对用户名、用户 ID 或邮箱进行哈希处理后生成的字符串,避免泄露用户隐私信息。
|
||
|
||
---
|
||
|
||
|
||
|
||
:::warning 部分参数升级说明
|
||
|
||
* **对于 resolution、ratio、duration、frames、seed、camera_fixed、watermark 参数,平台升级了参数传入方式,示例如下。所有模型依然兼容支持旧方式。**
|
||
* 不同模型,可能对应支持不同的参数与取值,详见 [输出视频格式](https://www.volcengine.com/docs/82379/1366799?lang=zh#9fe4cce0)。当输入的参数或取值不符合所选的模型时,该参数将被忽略或触发报错:
|
||
* 新方式:在 request body 中直接传入参数。此方式为**强校验,** 若参数填写错误,模型会返回错误提示。
|
||
* 旧方式:在文本提示词后追加 \-\-[parameters]。此方式为**弱校验,** 若参数填写错误,该参数将被忽略或触发报错。
|
||
|
||
|
||
:::
|
||
**新方式(推荐):在 request body 中直接传入参数**
|
||
```JSON
|
||
...
|
||
// Specify the aspect ratio of the generated video as 16:9, duration as 5 seconds, resolution as 720p, seed as 11, and include a watermark. The camera is not fixed.
|
||
"model": "doubao-seedance-1-5-pro-251215",
|
||
"content": [
|
||
{
|
||
"type": "text",
|
||
"text": "小猫对着镜头打哈欠"
|
||
}
|
||
],
|
||
// All parameters must be written in full; abbreviations are not supported
|
||
"resolution": "720p",
|
||
"ratio":"16:9",
|
||
"duration": 5,
|
||
// "frames": 29, Either duration or frames is required
|
||
"seed": 11,
|
||
"camera_fixed": false,
|
||
"watermark": true
|
||
...
|
||
```
|
||
|
||
|
||
|
||
|
||
**旧方式:在文本提示词后追加 \-\-[parameters]**
|
||
```JSON
|
||
...
|
||
// Specify the aspect ratio of the generated video as 16:9, duration as 5 seconds, resolution as 720p, seed as 11, and include a watermark. The camera is not fixed.
|
||
"model": "doubao-seedance-1-5-pro-251215",
|
||
"content": [
|
||
{
|
||
"type": "text",
|
||
"text": "小猫对着镜头打哈欠 --rs 720p --rt 16:9 --dur 5 --seed 11 --cf false --wm true"
|
||
// "text": "小猫对着镜头打哈欠 --resolution 720p --ratio 16:9 --duration 5 --seed 11 --camerafixed false --watermark true"
|
||
}
|
||
]
|
||
...
|
||
```
|
||
|
||
|
||
|
||
|
||
---
|
||
|
||
|
||
**resolution ** `string`
|
||
> seedance 2.0 & 2.0 fast、seedance 1.5 pro、seedance 1.0 lite 默认值:`720p`
|
||
> seedance 1.0 pro & pro\-fast 默认值:`1080p`
|
||
|
||
视频分辨率,枚举值:
|
||
|
||
* 480p
|
||
* 720p
|
||
* 1080p:seedance 1.0 lite 参考图场景、seedance 2.0 & 2.0 fast 不支持
|
||
|
||
|
||
---
|
||
|
||
|
||
**ratio ** `string`
|
||
> seedance 2.0 & 2.0 fast、seedance 1.5 pro 默认值为 `adaptive`
|
||
> seedance 1.0 lite 参考图场景默认值为 `16:9`
|
||
> 其他模型:文生视频默认值 `16:9`,图生视频默认值 `adaptive`
|
||
|
||
生成视频的宽高比例。不同宽高比对应的宽高像素值见下方表格。
|
||
|
||
* 16:9
|
||
* 4:3
|
||
* 1:1
|
||
* 3:4
|
||
* 9:16
|
||
* 21:9
|
||
* adaptive:根据输入自动选择最合适的宽高比(详见下文说明)
|
||
|
||
:::warning **adaptive ** 适配规则
|
||
当配置 **ratio** 为 `adaptive` 时,模型会根据生成场景自动适配宽高比;实际生成的视频宽高比可通过 [查询视频生成任务 API](https://www.volcengine.com/docs/82379/1521309?lang=zh) 返回的 **ratio** 字段获取。
|
||
**支持模型:**
|
||
|
||
* seedance 2.0 & 2.0 fast、seedance 1.5 Pro 支持
|
||
* 其他模型仅图生视频场景支持,注意 seedance 1.0 lite 参考图场景不支持。
|
||
|
||
**取值规则:**
|
||
|
||
* 文生视频:根据输入的提示词,智能选择最合适的宽高比。
|
||
* 首帧 / 首尾帧生视频:根据上传的首帧图片比例,自动选择最接近的宽高比。
|
||
* 多模态参考生视频:根据用户提示词意图判断,如果是首帧生视频/编辑视频/延长视频,以该图片/视频为准选择最接近的宽高比;否则,以传入的第一个媒体文件为准(优先级:视频>图片)选择最接近的宽高比。
|
||
|
||
:::
|
||
|
||
|
||
不同宽高比对应的宽高像素值
|
||
Note:图生视频,选择的宽高比与您上传的图片宽高比不一致时,方舟会对您的图片进行裁剪,裁剪时会居中裁剪,详细规则见 [图片裁剪规则](https://www.volcengine.com/docs/82379/1366799?lang=zh#f76aafc8)。
|
||
|
||
|分辨率 |宽高比|宽高像素值|宽高像素值|\
|
||
| | |seedance 1.0 系列 |seedance 1.5 pro|\
|
||
| | | |seedance 2.0 & 2.0 fast |
|
||
|---|---|---|---|
|
||
|480p |16:9 |864×480 |864×496 |
|
||
|^^|4:3 |736×544 |752×560 |
|
||
|^^|1:1 |640×640 |640×640 |
|
||
|^^|3:4 |544×736 |560×752 |
|
||
|^^|9:16 |480×864 |496×864 |
|
||
|^^|21:9 |960×416 |992×432 |
|
||
|720p |16:9 |1248×704 |1280×720 |
|
||
|^^|4:3 |1120×832 |1112×834 |
|
||
|^^|1:1 |960×960 |960×960 |
|
||
|^^|3:4 |832×1120 |834×1112 |
|
||
|^^|9:16 |704×1248 |720×1280 |
|
||
|^^|21:9 |1504×640 |1470×630 |
|
||
|1080p |16:9 |1920×1088 |1920×1080 |\
|
||
|> 1.0 lite 参考图场景不支持,seedance 2.0 & 2.0 fast不支持 | | | |
|
||
|^^|4:3 |1664×1248 |1664×1248 |
|
||
|^^|1:1 |1440×1440 |1440×1440 |
|
||
|^^|3:4 |1248×1664 |1248×1664 |
|
||
|^^|9:16 |1088×1920 |1080×1920 |
|
||
|^^|21:9 |2176×928 |2206×946 |
|
||
|
||
|
||
|
||
|
||
---
|
||
|
||
|
||
**duration** `integer` `默认值 5`
|
||
> duration 和 frames 二选一即可,frames 的优先级高于 duration。如果您希望生成整数秒的视频,建议指定 duration。
|
||
|
||
生成视频时长,仅支持整数,单位:秒。
|
||
|
||
* seedance 1.0 pro、seedance 1.0 pro fast、seedance 1.0 lite: [2, 12] s。
|
||
* seedance 1.5 pro: [4,12] 或设置为`-1`
|
||
* seedance 2.0 & 2.0 fast: [4,15] 或设置为`-1`
|
||
|
||
:::warning
|
||
seedance 2.0 & 2.0 fast、seedance 1.5 pro 支持两种配置方法
|
||
|
||
* 指定具体时长:支持有效范围内的任一整数。
|
||
* 智能指定:设置为 `-1`,表示由模型在有效范围内自主选择合适的视频长度(整数秒)。实际生成视频的时长可通过 [查询视频生成任务 API](https://www.volcengine.com/docs/82379/1521309?lang=zh) 返回的 **duration** 字段获取。注意视频时长与计费相关,请谨慎设置。
|
||
|
||
|
||
:::
|
||
---
|
||
|
||
|
||
**frames** `integer`
|
||
> seedance 2.0 & 2.0 fast、seedance 1.5 pro 暂不支持
|
||
> duration 和 frames 二选一即可,frames 的优先级高于 duration。如果您希望生成小数秒的视频,建议指定 frames。
|
||
|
||
生成视频的帧数。通过指定帧数,可以灵活控制生成视频的长度,生成小数秒的视频。
|
||
由于 frames 的取值限制,仅能支持有限小数秒,您需要根据公式推算最接近的帧数。
|
||
|
||
* 计算公式:帧数 = 时长 × 帧率(24)。
|
||
* 取值范围:支持 [29, 289] 区间内所有满足 `25 + 4n` 格式的整数值,其中 n 为正整数。
|
||
|
||
例如:假设需要生成 2.4 秒的视频,帧数=2.4×24=57.6。由于 frames 不支持 57.6,此时您只能选择一个最接近的值。根据 25+4n 计算出最接近的帧数为 57,实际生成的视频为 57/24=2.375 秒。
|
||
|
||
---
|
||
|
||
|
||
**seed** `integer` `默认值 -1`
|
||
种子整数,用于控制生成内容的随机性。
|
||
取值范围:[\-1, 2^32\-1]之间的整数。
|
||
:::warning
|
||
|
||
* 相同的请求下,模型收到不同的seed值,如:不指定seed值或令seed取值为\-1(会使用随机数替代)、或手动变更seed值,将生成不同的结果。
|
||
* 相同的请求下,模型收到相同的seed值,会生成类似的结果,但不保证完全一致。
|
||
|
||
|
||
:::
|
||
---
|
||
|
||
|
||
**camera_fixed** `boolean` `默认值 false`
|
||
> 参考图场景不支持,seedance 2.0 & 2.0 fast 暂不支持
|
||
|
||
是否固定摄像头。枚举值:
|
||
|
||
* true:固定摄像头。平台会在用户提示词中追加固定摄像头,实际效果不保证。
|
||
* false:不固定摄像头。
|
||
|
||
|
||
---
|
||
|
||
|
||
**watermark** `boolean` `默认值 false`
|
||
生成视频是否包含水印。枚举值:
|
||
|
||
* false:不含水印。
|
||
* true:含有水印。
|
||
|
||
|
||
---
|
||
|
||
|
||
<span id="oCS1tULg"></span>
|
||
## 响应参数
|
||
> 跳转 [请求参数](#RxN8G2nH)
|
||
|
||
**id ** `string`
|
||
视频生成任务 ID 。仅保存 7 天(从 **created at** 时间戳开始计算),超时后将自动清除。
|
||
|
||
* 设置`"draft": true`,为 Draft 视频任务 ID。
|
||
* 设置 `"draft": false`,为正常视频任务 ID。
|
||
|
||
创建视频生成任务为异步接口,获取 ID 后,需要通过 [查询视频生成任务 API](https://www.volcengine.com/docs/82379/1521309) 来查询视频生成任务的状态。任务成功后,会输出生成视频的`video_url`。
|
||
|
||
|