一知开放平台
  1. 短视频作品合成、编辑和查询
一知开放平台
  • 账户权益管理API
    • 开发说明
    • 实际登陆接口
      POST
    • 订单列表-用户充值消耗明细
      POST
    • 登录接口openApi
      POST
    • 数字人作品校验
      POST
    • 充值
      POST
    • 用户资源详情查询
      GET
    • 消息已读接口
      POST
    • 登出接口openApi
      POST
    • 更改账户状态
      POST
    • 获取用户直播并发详情
      GET
    • 消息列表
      POST
    • 创建用户
      POST
  • 短视频离线合成API
    • 调用须知
    • 常见问题
    • 流式TTS-音色需报备
    • 短视频作品合成、编辑和查询
      • 创建视频合成任务-音频文件
        POST
      • 创建视频合成任务-TTS合成
        POST
      • 更新视频作品名称
        POST
      • 合成任务状态查询接口
        GET
      • 查询合成视频作品列表
        GET
      • 短视频作品创建草稿
        POST
      • 删除视频作品
        GET
      • 复制短视频作品
        POST
      • 视频作品统计
        GET
      • 代理商查询其用户的所有视频作品列表
        POST
      • 预览短视频
        POST
      • 查询预览效果接口(轮询)
        GET
      • 模版列表
        POST
      • 模版详情
        GET
    • 音频作品合成、编辑和查询
      • 合成音频作品
      • 查询音频作品的详情
      • 音频作品的列表
      • 音频作品统计
      • 创建音频草稿
      • TTS合成接口
      • 代理商查询其用户的所有音频作品列表
      • 删除音频作品
      • TTS合成接口(支持标签)
    • 数字人和音色模型
      • 免费模特列表查询
      • 定制模特列表查询
      • 删除模特资产
      • AI合成音列表查询
      • AI合成音查询
      • 定制
      • 音色定制
      • 更新数字人模特名称
      • 更新音色资产名称
      • 删除定制声音资产
      • 同步至短视频平台
      • 同步至直播平台
    • 素材准备和编辑
      • 配音-录音上传
      • 获取上传的录音
      • 背景上传
      • 背景查询-静态背景
      • 背景查询-获取上传的背景
      • 根据音频生成字幕
      • 解析抖音短视频
      • 生成字幕
      • 获取oss签名
      • 获取oss上传ststoken
  • 直播OpenApi
    • 调用须知
    • 常见问题
    • 实时信息同步
    • 直播阿凡达模式WS连接
    • 直播流程相关
      • 直播间详情
      • 添加直播间素材,创建直播间
      • 开始直播
      • 获取开播的详情
      • 结束直播
      • 插入播放音频
      • 获取当前播放的音频信息
      • 跳转到指定场景指定音频播放
      • 直播间ping后端的接口 10s/次轮训
      • 获取当前账号正在直播的直播间信息
      • 导购商品手动加到插播列表
      • 开播前更新直播间配置
      • 直播中更新直播间素材
      • 直播中插入播放副本到列表
      • 预览直播接口
      • 获取预览链接
      • 获取当前账号正在直播的直播间列表
      • 直播并发列表接口
      • 删除直播间
      • 更新直播间的推流地址
      • 场景隐藏和公开
      • 删除当前已有的音频
      • 新增场景
      • 场景排序
    • 直播素材准备和编辑
      • 背景上传
      • 获取背景的集合
      • 创建素材
      • 素材列表
      • 音色列表
      • 新建商品
      • 类目列表
      • 删除商品
      • 商品列表
      • 编辑商品
  • 数字人互动
    • 互动素材准备和编辑
      • 删除素材
      • 背景上传
      • 素材列表
      • 获取背景的集合
      • 创建素材
    • 互动TalkTo版
      • 创建直播间
      • 开始直播
      • 对话接口
      • 退出直播
  1. 短视频作品合成、编辑和查询

创建视频合成任务-音频文件

POST
/openApiDigitalPerson/customer/composeWithAudio
文件格式和大小说明,超过限制会造成合成失败:
背景:
支持JPG/JPEG/PNG图片,最多可同时上传100张背景,图片限制30M。
音频/配音
仅支持mp3、wav、m4a、flac格式
图片:
JPG/JPEG/PNG/GIF格式图片,限制30M
视频:
mp4/webm/mov/flv格式,限制500M

请求参数

Header 参数
authorization
string 
必需
所有接口都需 MD5(APP_ID+APP_SECRET+timestamp) 32位小写 APP_SECRET需要我们提供
示例值:
{{auth|md5}}
req_from
string 
必需
直销客户传C ,代理商传D
示例值:
C
timestamp
integer 
时间戳
必需
示例值:
{{timestamp}}
app_id
string 
必需
APPID,开启后获得
示例值:
{{appId}}
account
string 
可选
代理商的客户账号,直销客户不传,代理商必传
示例值:
19999999999
Body 参数application/json
sceneVOList
array [object {2}] 
场景列表
必需
trackPO
object 
必需
orderBy
integer 
排序
必需
顺序(升序),用于场景排序
name
string 
xxx作品
必需
作品名
isPreview
string 
可选
是否是预览 false为不是,默认为false true为是
align
enum<string> 
VERTICAL
必需
横竖屏 VERTICAL:竖版 HORIZONTAL横版
枚举值:
HORIZONTALVERTICAL
resolution
string 
1080P
必需
分辨率
示例
{
    "name": "测试OpenApi的作品0712-1",
    "resolution": "1080P",
    "align": "VERTICAL",
    "sceneVOList": [
        {
            "orderBy": 1,
            "trackPO": {
                "audioTrack": [
                    {
                        "duration": 10.893063,
                        "digitalPersonWorksUploadAudioId": 994,
                        "durationBySpeed": 10.893063,
                        "mediaURL": "https://digital-person-daily.oss-cn-hangzhou.aliyuncs.com/virtual_human/81/Audio/Record/1689063568381/口播老师1.MP3"
                    }
                ],
                "backGroundImageTrack": {
                    "backgroundId": 324,
                    "mediaURL": "https://digital-person-daily.oss-cn-hangzhou.aliyuncs.com/FileUpload/1/UID_1/Image/Background/766217fa27993ecdc73d8abf326cbec8_1678409491325.jpg"
                },
                "digitalPersonTrack": [
                    {
                        "z": 3,
                        "digitalPersonAssetsId": 135,
                        "name": "白白",
                        "scale": 1,
                        "height": 1920,
                        "type": "Video",
                        "x": 0,
                        "y": 0,
                        "mediaURL": "https://digital-person-daily.oss-cn-hangzhou.aliyuncs.com/virtual_human/templates/白白_1682217983080_1682242874279632/白白_1682217983080_1682242874279632.png",
                        "width": 1080
                    }
                ],
                "imageTrack": [
                    {
                        "z": 2,
                        "speed": 1,
                        "type": "Image",
                        "name": "加入我粉丝团.png",
                        "timelineIn": 0,
                        "timelineOut": 10.893063,
                        "y": 493.843,
                        "x": 0,
                        "mediaURL": "https://digital-person.oss-cn-hangzhou.aliyuncs.com/FileUpload/UID_196/File/2023-12-08/1701999438939加入我粉丝团.png",
                        "height": 932.314,
                        "width": 1082.0493
                    },
                    {
                        "z": 1,
                        "speed": 1,
                        "type": "Image",
                        "name": "加入我粉丝团.png",
                        "timelineIn": 0,
                        "timelineOut": 10.893063,
                        "y": -8.9274235,
                        "x": -51.00569,
                        "mediaURL": "https://digital-person.oss-cn-hangzhou.aliyuncs.com/FileUpload/UID_196/File/2023-12-08/1701999438939加入我粉丝团.png",
                        "height": 932.314,
                        "width": 1082.0493
                    }
                ],
                "subtitleTrack": [
                    {
                        "timelineIn": 2,
                        "timelineOut": 5,
                        "type": "Text",
                        "x": 0.1,
                        "y": 0.1,
                        "content": "系统花字",
                        "fontSize": 150,
                        "effectColorStyle": "CS0001-000004"
                    },
                    {
                        "type": "Text",
                        "content": "你好呀",
                        "timelineIn": 0,
                        "timelineOut": 5.813,
                        "z": 100,
                        "backColour": "#00000000",
                        "font": "SiYuan Heiti",
                        "fontSize": 58.29222011385199,
                        "fontColor": "#ffffff",
                        "outlineColour": "#000000",
                        "fontFace": {
                            "bold": false,
                            "underline": false,
                            "italic": false
                        },
                        "x": 541.0246679316888,
                        "y": 1400,
                        "outlinef": 6,
                        "textWidth": 174.87666034155598,
                        "textHeight": 58.29222011385199,
                        "textRows": [
                            "你好呀"
                        ],
                        "speed": 1
                    }
                ]
            }
        }
    ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/openApiDigitalPerson/customer/composeWithAudio' \
--header 'authorization: {{auth|md5}}' \
--header 'req_from: C' \
--header 'timestamp: {{timestamp}}' \
--header 'app_id: {{appId}}' \
--header 'account: 19999999999' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "测试OpenApi的作品0712-1",
    "resolution": "1080P",
    "align": "VERTICAL",
    "sceneVOList": [
        {
            "orderBy": 1,
            "trackPO": {
                "audioTrack": [
                    {
                        "duration": 10.893063,
                        "digitalPersonWorksUploadAudioId": 994,
                        "durationBySpeed": 10.893063,
                        "mediaURL": "https://digital-person-daily.oss-cn-hangzhou.aliyuncs.com/virtual_human/81/Audio/Record/1689063568381/口播老师1.MP3"
                    }
                ],
                "backGroundImageTrack": {
                    "backgroundId": 324,
                    "mediaURL": "https://digital-person-daily.oss-cn-hangzhou.aliyuncs.com/FileUpload/1/UID_1/Image/Background/766217fa27993ecdc73d8abf326cbec8_1678409491325.jpg"
                },
                "digitalPersonTrack": [
                    {
                        "z": 3,
                        "digitalPersonAssetsId": 135,
                        "name": "白白",
                        "scale": 1,
                        "height": 1920,
                        "type": "Video",
                        "x": 0,
                        "y": 0,
                        "mediaURL": "https://digital-person-daily.oss-cn-hangzhou.aliyuncs.com/virtual_human/templates/白白_1682217983080_1682242874279632/白白_1682217983080_1682242874279632.png",
                        "width": 1080
                    }
                ],
                "imageTrack": [
                    {
                        "z": 2,
                        "speed": 1,
                        "type": "Image",
                        "name": "加入我粉丝团.png",
                        "timelineIn": 0,
                        "timelineOut": 10.893063,
                        "y": 493.843,
                        "x": 0,
                        "mediaURL": "https://digital-person.oss-cn-hangzhou.aliyuncs.com/FileUpload/UID_196/File/2023-12-08/1701999438939加入我粉丝团.png",
                        "height": 932.314,
                        "width": 1082.0493
                    },
                    {
                        "z": 1,
                        "speed": 1,
                        "type": "Image",
                        "name": "加入我粉丝团.png",
                        "timelineIn": 0,
                        "timelineOut": 10.893063,
                        "y": -8.9274235,
                        "x": -51.00569,
                        "mediaURL": "https://digital-person.oss-cn-hangzhou.aliyuncs.com/FileUpload/UID_196/File/2023-12-08/1701999438939加入我粉丝团.png",
                        "height": 932.314,
                        "width": 1082.0493
                    }
                ],
                "subtitleTrack": [
                    {
                        "timelineIn": 2,
                        "timelineOut": 5,
                        "type": "Text",
                        "x": 0.1,
                        "y": 0.1,
                        "content": "系统花字",
                        "fontSize": 150,
                        "effectColorStyle": "CS0001-000004"
                    },
                    {
                        "type": "Text",
                        "content": "你好呀",
                        "timelineIn": 0,
                        "timelineOut": 5.813,
                        "z": 100,
                        "backColour": "#00000000",
                        "font": "SiYuan Heiti",
                        "fontSize": 58.29222011385199,
                        "fontColor": "#ffffff",
                        "outlineColour": "#000000",
                        "fontFace": {
                            "bold": false,
                            "underline": false,
                            "italic": false
                        },
                        "x": 541.0246679316888,
                        "y": 1400,
                        "outlinef": 6,
                        "textWidth": 174.87666034155598,
                        "textHeight": 58.29222011385199,
                        "textRows": [
                            "你好呀"
                        ],
                        "speed": 1
                    }
                ]
            }
        }
    ]
}'

返回响应

🟢200成功
application/json
Body
com.yiwise.base.model.bean.ResultModel<java.lang.Long>
code
integer 
可选
错误代码,200表示执行成功
默认值:
CommonErrorCode.SUCCESS.getCode()
data
integer 
返回的数据
可选
requestId
string 
请求唯一标记
可选
resultMsg
string 
提示信息
可选
默认值:
CommonErrorCode.SUCCESS.getDesc()
host
string 
业务主机名
可选
默认值:
getHostName()
errorStackTrace
string 
异常堆栈
可选
示例
{
    "code": 200,
    "data": 2454,
    "requestId": "qvshUtaa",
    "resultMsg": "执行成功",
    "host": "develop-007",
    "errorStackTrace": null
}
修改于 2024-12-13 01:49:52
上一页
流式TTS-音色需报备
下一页
创建视频合成任务-TTS合成
Built with