接口使用HTTP 1.1 协议,遵循RESTful规范;
接口调用的基础地址:https://api.deepsound.cn/
鉴权流程, 请参考深声官网签名方式: 签名方式
音频要求:
视频要求:
本接口用于音频驱动模板视频,快速生成数字人对口型的视频。不需要训练模型,适用于需要批量生成不同人像视频的场景,比如营销视频。
请求路径
接口标识 | 请求路径 | 请求方式 | 说明 |
---|---|---|---|
avatar.v2.2D.createVideo | /avatar/v2/video/create | POST | 用于创建视频生成任务。 |
body参数
字段名 | 类型 | 是否必选 | 说明 |
---|---|---|---|
audio_url | String | 是 | 驱动音频URL,长度不超过256字符。 |
video_url | String | 是 | 数字人模板视频URL,长度不超过256字符。 |
callback_url | String | 否 | 视频生成结果回调地址,如果存在,则必须公网可访问,长度不超过256字符。 |
video_info | String | 否 | 用户自定义字段,用于标识该视频;不超过128字符。 |
返回值
字段名 | 类型 | 是否返回 | 说明 |
---|---|---|---|
code | Integer | 是 | 响应成功时取值为整数0, 其它取值详见状态码说明。 |
message | String | 否 | 关于响应结果的说明。 |
data | Object | 是 | 后续表格中,"data.x"表示data对象的属性x。如果code不为0,data字段为空,data中的其他数据将无法获取。 |
data.video_id | String | 是 | 视频生成任务的任务ID。 |
错误码
错误码 | 错误码说明 |
---|---|
1001 | 参数错误 |
请求路径
接口标识 | 请求路径 | 请求方式 | 说明 |
---|---|---|---|
avatar.v2.2D.queryVideo | /avatar/v2/video/status | GET | 用于查询一条数字人视频记录。 |
query参数
字段名 | 类型 | 是否必选 | 说明 |
---|---|---|---|
video_id | Integer | 是 | 视频ID,来自于 avatar.v2.2D.createVideo 接口的返回值。 |
返回值
字段名 | 类型 | 是否返回 | 说明 |
---|---|---|---|
code | Integer | 是 | 响应成功时取值为整数0, 其它取值详见状态码说明。 |
message | String | 否 | 关于响应结果的说明。 |
data | Object | 是 | 后续表格中,"data.x"表示data对象的属性x。如果code不为0,data字段为空,data中的其他数据将无法获取。 |
data.video_url | String | 否 | 任务正常完成后的视频链接地址,3天有效。 |
data.expire_at | Integer | 否 | 视频链接失效的时间戳,单位为秒。 |
data.video_info | String | 是 | avatar.v2.2D.createVideo接口传入的video_info参数。 |
data.audio_duration | String | 是 | 输入音频的时长,单位为秒。 |
data.message | String | 是 | 任务状态信息。 |
data.status | String | 是 | 任务状态码:0=未开始,1=预处理,2=处理中,3=后处理,4=成功,5=失败,6=超时。 |
data.progress | Integer | 是 | 任务整体进度,0-100。 |
错误码
错误码 | 错误码说明 |
---|---|
1001 | 参数错误 |
请求路径
接口标识 | 请求路径 | 请求方式 | 说明 |
---|---|---|---|
avatar.v2.2D.callback | 用户自定义 | POST | 视频生成回调接口。 |
body参数
字段名 | 类型 | 是否必选 | 说明 |
---|---|---|---|
video_id | String | 是 | avatar.v2.2D.createVideo接口返回的video_id参数。 |
status | String | 是 | 任务状态码:0=未开始,1=预处理,2=处理中,3=后处理,4=成功,5=失败,6=超时。 |
message | String | 是 | 任务状态信息。 |
video_url | String | 否 | 最终生成的视频链接,有效期3天。 |
expire_at | Integer | 否 | 视频链接失效的时间戳,单位为秒。 |
audio_duration | String | 是 | 输入音频的时长,单位为秒。 |
video_info | String | 是 | avatar.v2.2D.createVideo接口传入的video_info参数。 |
回调重试策略
在调用失败后,会按照如下配置进行重试。请保证回调接口的幂等性,不因重试引起业务处理异常。
回调超时时间:5秒
回调重试次数:3次
重试间隔:15秒