You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /视频点播/视频 AI 应用/服务端 OpenAPI/AI 解说生成/CreateDramaRecapTask - 创建解说视频生成任务
CreateDramaRecapTask - 创建解说视频生成任务
最近更新时间：2025.10.11 15:18:39首次发布时间：2025.10.11 15:18:39
复制全文
我的收藏
有用
有用
无用
无用

调用 CreateDramaRecapTask 接口创建短剧解说视频生成任务。

使用说明

本接口为异步接口，调用成功后会返回一个任务 ID。您可通过以下方式获取处理结果：

注意事项

  • 该接口仅支持白名单用户调用。使用前请提交工单联系火山引擎技术支持团队申请开通。
  • 本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。
  • 短剧视频限制：
    • 视频总时长：单次任务处理的所有视频累计时长不超过 90 分钟（约等于一部 45 集的短剧）。
    • 分辨率一致性：提交的多个视频，其分辨率（宽高）必须保持一致。
    • 字幕要求：视频必须包含内嵌字幕（硬字幕）。暂不支持无字幕或外挂字幕的视频。
    • 格式限制：暂不支持 HLS（M3U8）格式的视频。
    • 存储限制：暂不支持处理挂载在对象存储桶中的视频。

请求说明

  • 请求方式：POST
  • 请求地址：https://vod.volcengineapi.com?Action=CreateDramaRecapTask&Version=2025-03-03

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数
类型
是否必选
示例值
描述
Action
String
是
CreateDramaRecapTask
接口名称。当前 API 的名称为 CreateDramaRecapTask。
Version
String
是
2025-03-03
接口版本。当前 API 的版本为 2025-03-03。

Body

参数
类型
是否必选
示例值
描述
SpaceName
String
是
test

点播空间名。您可通过以下方式获取空间名称：

  • 在视频点播控制台空间管理页面查看当前账号下所有空间的名称。
  • 调用 ListSpace 接口获取当前账号下所有空间的名称。
Vids
String[]
否
["v02b69g10000***eldb8vjafvmg"]

待处理的视频 ID 列表，支持传入多个视频 ID 进行批量处理。若传入该字段，系统会先进行剧本还原，再进行解说视频生成。

说明

DramaScriptTaskId 与 Vids 参数互斥，只能填写其中一个。

DramaScriptTaskId
String
否
v02bbbg1006***kbdminbj659kvikr10

剧情分析任务 ID。若传入该字段，系统会参考该任务 ID 对应的剧本还原结果进行解说视频生成。

说明

  • DramaScriptTaskId 与 Vids 参数互斥，只能填写其中一个。
  • 请确保 DramaScriptTaskId 对应的剧本还原任务状态为成功，否则本次请求会失败。
RecapText
String
是
这是一部关于都市爱情的短剧，讲述了两位年轻人在繁华都市中相遇、相知、相爱的故事。剧情紧凑，情感真挚，展现了现代年轻人对爱情的追求与坚持。
短剧解说词文本内容。
SpeakerConfig
Object
是
-
语音合成配置。
AppId
String
是
1574***863
豆包语音的 APP ID。具体请见豆包语音快速入门。
Cluster
String
否
volcano_tts
固定值为 volcano_tts。
VoiceType
String
是
zh_female_vv_uranus_bigtts

音色 ID。

  • 若您使用语音合成大模型，对应 voice_type 字段。详见音色列表。
  • 若您使用声音复刻大模型，对应 speakerid 字段。具体请参考声音复刻文档。
IsEraseSubtitle
Boolean
否
true

是否擦除原视频中的字幕。

  • true：系统会在生成解说视频时移除原有字幕。
  • false：（默认）系统会在生成解说视频时保留原有字幕。
FontConfig
Object
否
-
字幕字体配置
PosX
Integer
否
360
字幕左上角相对于输出视频左上角在 X 轴上的位移，单位为 pixel。默认值为 FontSize/2。
PosY
Integer
否
720
字幕左上角相对于输出视频左上角在 Y 轴上的位移，单位为 pixel。默认值为（视频高度 - 5.5*FontSize）。
Alpha
Double
否
1
字体透明度，取值范围 [0,1]。0 为透明。默认为 1。
Width
Integer
否
1080
字幕宽度，单位为 pixel。默认字幕宽度为视频宽度 - FontSize。
Height
Integer
否
720
字幕高度，单位为像素。默认值为 4 倍的 FontSize。
TextRes
String
否
1179437
花字 ID。默认为空字符串。
FontSize
Integer
否
75
字体大小，单位为 pixel。默认值为 Width*0.07。例如字幕宽度为 1080，则字体大小为 75。
FontType
String
否
1525741
字体 ID。默认字体为方正雅宋。
AlignType
Integer
否
1

文本对齐方式。默认值为 1。需和 Typesetting 参数配合使用。

  • 当文字横排时，支持的取值如下所示。
    • 0：左对齐；
    • 1：居中对齐；
    • 2：右对齐。
  • 当文字竖排时，支持的取值如下所示。
    • 1：居中对齐；
    • 3：上对齐；
    • 4：下对齐。
FontColor
String
否
#FFCC66FF

字体颜色。RGBA 类型。如果没有使用花字，颜色默认为白色。

说明

只支持基础文字，不支持花字。

NoSubtitle
Boolean
否
true

是否在生成的解说视频中不添加硬字幕。

  • true：不生成硬字幕。
  • false：（默认）生成硬字幕。
BorderColor
String
否
#FF0000FF

字幕的描边颜色，使用 RGBA 格式表示。默认值为 #00000000（透明）。

说明

只支持基础文字，不支持花字。

BorderWidth
Integer
否
2
字幕的描边宽度，单位为 pixel。最小值为 1，最大值不能超过 FontSize 的 0.1 倍。
Typesetting
Integer
否
1

文字排列方向：

  • 0: （默认）文字横排。
  • 1: 文字竖排。
LineMaxWidth
Double
否
1

自动换行宽度。默认值为 1，和 Width 保持一致。可设为 0 到 1 之前的一个数字，表示自动换行宽度的占比。

  • 如果 Typesetting 参数取值为 0 ，基准是 Width 大小。
  • 如果 Typesetting 参数取值为 1 ，基准是 Height 大小。
BackgroundColor
String
否
#00000080

字幕的背景颜色，使用 RGBA 格式表示。默认值为 #00000000。

说明

  • 仅覆盖文字，如果是多行文字，则以最长的一行为准。
  • 只支持基础文字，不支持花字。
BackgroundBorderSize
Double
否
0
字体背景边框大小。默认值为 0。背景颜色仅仅跟随文字。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数
类型
示例值
描述
TaskId
String
v02bbbg1006***kbdminbj659kvikr10
解说视频生成任务 ID。
DramaScriptTaskId
String
v02bbbg1006***kbdminbj659kvikr0g
剧本还原任务 ID。

请求示例

POST https://vod.volcengineapi.com?Action=CreateDramaRecapTask&Version=2025-03-03
{
  "SpaceName": "test",
  "Vids": [
    "v02b69g10000***eldb8vjafvmg"
  ],
  "DramaScriptTaskId": "v02bbbg1006***kbdminbj659kvikr10",
  "RecapText": "这是一部关于都市爱情的短剧，讲述了两位年轻人在繁华都市中相遇、相知、相爱的故事。剧情紧凑，情感真挚，展现了现代年轻人对爱情的追求与坚持。",
  "SpeakerConfig": {
    "AppId": "1574***863",
    "Cluster": "volcano_tts",
    "VoiceType": "zh_female_vv_uranus_bigtts"
  },
  "IsEraseSubtitle": true,
  "FontConfig": {}
}

返回示例

{
  "ResponseMetadata": {
    "Action": "CreateDramaRecapTask",
    "Region": "cn-north-1",
    "Service": "vod",
    "Version": "2025-03-03",
    "RequestId": "20230604110420****100232280022D31"
  },
  "Result": {
    "TaskId": "v02bbbg10064d3kbdminbj659kvikr10",
    "DramaScriptTaskId": "v02bbbg10064d3kbdminbj659kvikr0g"
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。