跳转到文档内容
接口文档 / 口播音视频

批量生成口播视频

为每条脚本、数字人和外观组合提交一个视频渲染任务,可独立设置字幕;音频试听不是必经步骤。

v1异步任务 Bearer 鉴权
POSThttps://popto.cn/api/open/v1/toolbox/batch_render_avatar

鉴权与请求头

在 API 密钥管理 ↗ 创建密钥,每次请求在 HTTP Header 中携带。

AuthorizationBearer <POPTO_API_KEY>必填
Content-Typeapplication/json必填

请求参数 Body · JSON

tool_idstring可选

首次提交可省略或留空,自动创建工具箱项目;后续音频和视频提交复用同一 tool_id,项目须属于当前用户。

selected_render_avatarsobject[]必填

视频生成配置,至少一项。

查看数组元素字段 8
voiceoverobject可选

展开查看对象字段。

查看子字段 6
topicstring可选

口播主题。

anglestring可选

内容角度。

draftstring可选

口播正文,使用时须为非空文本。

expression_stylestring可选

表达风格。

source_idstring可选

可选的文案来源 ID。

versioninteger可选

可选的文案版本。

scriptstring可选

口播正文,优先于 voiceover.draft;两者至少一个为非空文本。

aiactorobject必填

数字人对象,可直接保留列表返回的完整对象。提交时至少包含 actor_id。

查看子字段 35
actor_idstring必填

从数字人列表取得的真实角色 ID,不能为空。

namestring可选

数字人名称,建议保留以便项目展示。

idinteger可选

角色记录 ID。

ctinteger可选

创建时间,Unix 秒。

utinteger可选

更新时间,Unix 秒。

hired_bystring可选

角色租用信息。

hired_atinteger可选

角色租用时间。

agestring可选

年龄分类。

genderstring可选

性别。

situationstring[]可选

适用场景。

posestring可选

姿势。

shot_typestring可选

景别。

skin_tonestring可选

肤色。

accessoriesJSON可选

配饰信息,JSON 值。

voice_idstring可选

声音 ID;使用角色已配置的声音。

special_forJSON可选

角色适用信息,JSON 值。

preview_urlstring可选

预览地址。

photo_urlstring可选

角色照片地址。

original_show_off_urlstring可选

原始展示视频地址。

show_off_urlstring可选

展示视频地址。

lightstring可选

光照描述。

audition_audio_urlstring可选

声音试听地址。

scoreinteger可选

角色评分。

favouriteboolean可选

当前用户是否收藏。

statusstring可选

角色状态;自建角色可能仍在生成中。

voicesJSON可选

角色声音信息,JSON 值。

voice_vendorstring可选

声音服务商。

voice_account_idinteger可选

声音账号标识。

ethnicitystring可选

族裔。

posesstring[]可选

姿势标签。

shot_typesstring[]可选

景别标签。

industriesstring[]可选

行业标签。

subregionstring可选

地区。

professionsstring[]可选

职业标签。

looksobject[]可选

可选外观;使用其中的 look_id,不要根据名称猜测 ID。

查看数组元素字段 10
look_idstring可选

外观 ID。

namestring可选

外观名称。

background_image_urlstring可选

背景图地址。

clothes_image_urlstring可选

服装图地址。

result_image_urlstring可选

外观结果图地址。

promptstring可选

外观描述。

statusinteger可选

外观状态码。

ctinteger可选

创建时间,Unix 秒。

preview_urlstring可选

外观预览图片或视频地址。

error_msgstring可选

外观生成错误信息。

with_subtitleboolean可选

是否给成片叠加字幕,默认 false。

subtitle_styleobject可选

完整字幕样式对象,建议直接使用字幕预设列表的返回项;不能只传 ID。

查看子字段 13
idstring可选

字幕样式 ID。

namestring可选

样式名称。

font_namestring可选

字体名称,从字体列表选择。

font_urlstring可选

可选字体文件 URL。

font_sizenumber可选

字体大小。

boldboolean可选

是否加粗。

italicboolean可选

是否斜体。

text_colorstring可选

文字颜色。

background_colorstring可选

背景颜色。

stroke_colorstring可选

描边颜色。

stroke_widthnumber可选

描边宽度。

opacitynumber可选

透明度。

letter_spacingnumber可选

字间距。

audio_urlstring可选

可选试听音频 URL,保存为任务元数据;当前视频合成仍按脚本和角色驱动,不承诺直接复用该音轨。

durationinteger可选

口播时长,整数秒。正值参与预扣费计算;省略或非正值时按正文约 5 字/秒向上取整估算。

selected_look_idsstring[]可选

每个非空 ID 生成一个视频;省略、空数组或仅含空白时使用默认外观。

返回值与结构

成功时 ret = 0,业务数据位于 data.ent。以下为 data.ent 中的字段。

tool_idstring

工具箱项目 ID。

task_idsstring[]

按输入配置及各外观顺序展开的任务 ID 数组;每条配置可能返回多个任务。

调用说明

  • 每条 selected_render_avatars 按非空 selected_look_ids 逐个展开;未选择外观时只生成一个默认外观视频。批量权益按展开后的视频数量校验,超限返回 70010。
  • 通过 task/batch_get 或 toolbox/get_info 查询 task_type=aiactor_perform_render_avatar;status=success 后读取 outputs.items[].output_video_url,可选字段包括 output_mime_type、workspace_id、workspace 与 analysis。
  • 可以先生成音频,再携带同一 tool_id、audio_url 和向上取整的真实 duration 生成视频;audio_url 当前仅作元数据保存,duration 用于费用计算,不应据此承诺成片直接复用试听音轨。
  • 按预估时长预扣视频积分,失败由原任务逻辑处理退款。循环提交中途失败可能已经创建部分任务,没有整批回滚保证;先核对已创建的任务。
  • 接口使用 Bearer API Key 识别当前注册用户,生成服务身份由服务端加载,不需要也不能通过请求体覆盖 uid、owner 或 h_m。
  • 提交接口没有幂等保证;网络超时、5xx 或不完整回执时可能已经创建任务。先用已保存的 tool_id、task_id 或项目中心核对,不要自动重放生成请求。
处理业务响应
HTTP 200 仍可能返回业务错误,请同时检查 ret、code 和 msg。查看响应与错误码