# API对接

# 前提条件

# 构造签名，获取access_token

对接数字人开放平台时，需在自己平台中构造签名并调用开放接口获取access_token。

如何获取access_token (opens new window)

# 1. 账户权益

接口地址：

/openapi/user/v2/get?access_token=55d1bc37-f960-4a9d-8c7d-5dc8c991c245

请求方式：GET

请求数据类型：application/json

响应数据类型：application/json

# 接口描述：

查询客户账户权益信息。

# 请求参数：

无

# 响应参数：

字段	类型	是否必须	备注
code	String	Y	返回的状态码，为0表示成功
success	Boolean	Y	成功/错误
message	String	Y	成功/错误的描述信息
data	Json	Y	返回的JSONObject
user	Json	Y	用户信息
id	Integer	Y	用户id
corpId	Integer	Y	企业id
account	Json	Y	账户信息
fastTrainingAmount	Long	Y	极速形象克隆剩余次数
totalFastTrainingAmount	Long	Y	极速形象克隆总次数
voiceCloneAmount	Long	Y	极速声音克隆剩余次数
totalVoiceCloneAmount	Long	Y	极速声音克隆总次数
fastDuration	Long	Y	视频合成剩余时长（单位：毫秒）
totalFastDuration	Long	Y	视频合成总时长（单位：毫秒）
ttsWordsAmount	Long	Y	声音合成剩余字数
totalTtsWordsAmount	Long	Y	声音合成总字数

示例：

{
    "code": "0",
    "message": "请求成功",
    "success": true,
    "data": {
        "user": {
            "id": 1005103,
            "corpId": 1004892
        },
        "account": {
            "fastTrainingAmount": 3,
            "totalFastTrainingAmount": 5,
            "voiceCloneAmount": 0,
            "totalVoiceCloneAmount": 0,
            "ttsWordsAmount": 969,
            "totalTtsWordsAmount": 1000,
            "fastDuration": 4894626,
            "totalFastDuration": 20000
        }
    }
}

# 2. 公共形象、公共配音

# 2.1 公共形象列表

接口地址：

/openapi/robot/v2/fastPublicPageList?access_token=55d1bc37-f960-4a9d-8c7d-5dc8c991c245

请求方式：POST

请求数据类型：application/json

响应数据类型：application/json

# 接口描述：

查询公共数字人形象列表。

# 请求参数：

字段	类型	是否必须	备注
page	Integer	Y	页数
size	Integer	Y	页大小
name	String	N	数字人名称

# 响应参数：

字段	类型	是否必须	备注
code	String	Y	返回的状态码，为0表示成功
success	Boolean	Y	成功/错误
message	String	Y	成功/错误的描述信息
data	Json	N	返回的JSONObject
pageSize	Integer	N	页大小
pageNo	Integer	N	页数
totalRecord	Integer	N	总数
records	List	N	数字人列表
id	Integer	Y	场景id（即：视频合成的sceneId）
sceneName	String	N	场景名称
coverUrl	String	N	封面地址
resolution	String	N	分辨率

示例：

{
    "code": "0",
    "message": "请求成功",
    "success": true,
    "data": {
        "pageSize": 10,
        "pageNo": 1,
        "totalRecord": 1,
        "records": [
            {
                "id": -292,
                "sceneName": "test",
                "coverUrl": "http://127.0.0.1/images/test.jpg",
                "resolution": "1080x1920"
            }
        ]
    }
}

# 2.2 公共配音列表

接口地址：

/openapi/speaker/v2/fastPublicPageList?access_token=55d1bc37-f960-4a9d-8c7d-5dc8c991c245

请求方式：POST

请求数据类型：application/json

响应数据类型：application/json

# 接口描述：

查询公共配音列表。

# 请求参数：

字段	类型	是否必须	备注
page	Integer	Y	页数
size	Integer	Y	页大小
name	String	N	声音名称
sex	Integer	N	性别 1: 男，2：女

# 响应参数：

字段	类型	是否必须	备注
code	String	Y	返回的状态码，为0表示成功
success	Boolean	Y	成功/错误
message	String	Y	成功/错误的描述信息
data	Json	N	返回的JSONObject
pageSize	Integer	N	页大小
pageNo	Integer	N	页数
totalRecord	Integer	N	总数
records	List	N	声音列表
speakerId	String	Y	声音id
ttsName	String	N	声音名称
ttsFeatures	String	N	声音特征
audioUrl	String	N	音频素材地址
ttsAudition	String	N	示例音频地址
languages	String	N	支持的语种
sex	Integer	N	性别 1: 男，2：女
status	Integer	Y	状态 0-准备中 1-训练中 2-训练成功 3-训练失败 4-已过期

示例：

{
    "code": "0",
    "message": "请求成功",
    "success": true,
    "data": {
        "pageSize": 10,
        "pageNo": 1,
        "totalRecord": 10,
        "records": [
            {
                "speakerId": "C_173",
                "ttsName": "test",
                "ttsFeatures": "沉稳|磁性|温柔",
                "ttsAudition": "http://127.0.0.1/wavs/500806libai.wav",
                "languages": [
                    "zh"
                ],
                "sex": 1,
                "status": 2
            }
        ]
    }
}

# 3. 极速形象克隆

# 3.1 极速形象克隆

接口地址：

/openapi/video/v3/create/training?access_token=ae4dad61-0dc5-47ad-be20c51245db2769

请求方式：POST

请求数据类型：application/json

响应数据类型：application/json

# 接口描述：

提供数字人极速形象克隆的能力。

# 请求参数：

字段	类型	是否必须	备注
id	Integer	N	训练id，id为空表示提交新训练，id不为空表示更新训练
name	String	Y	数字人名称
videoUrl	String	Y	训练视频地址
authorizeUrl	String	Y	授权视频地址
authorizeText	String	Y	授权视频说话文本
level	Integer	Y	定制套餐级别：1.极速形象克隆
compress	boolean	N	视频素材是否压缩处理
callbackUrl	String	N	训练回调地址

授权视频说话文本内容：我是XXX（真实姓名），同意授权硅基（guiji）智能，对我的形象进行克隆，用于视频合成。
授权说明：克隆主体姓名和授权主体公司为变量参数。

# 响应参数：

字段	类型	是否必须	备注
code	String	Y	返回的状态码，为0表示成功
success	Boolean	Y	成功/错误
message	String	Y	成功/错误的描述信息
data	Json	Y	返回的JSONObject
trainingId	Integer	Y	训练id

示例：

{
    "code": "0",
    "message": "请求成功",
    "success": true,
    "data": {
        "trainingId": 181
    }
}

# 3.2 极速形象克隆回调

接口地址：

用户提交数字人训练请求中的callback参数

请求方式：POST

请求数据类型：application/json

响应数据类型：application/json

# 接口描述：

用于开放平台回调通知客户端极速形象克隆的结果。

# 请求参数：

字段	类型	是否必须	备注
taskType	String	Y	值为"video-training"表示视频训练任务回调
data	Json	Y	JSONObject
id	Integer	Y	训练id
result	String	Y	success：成功, fail：失败
reason	String	N	失败原因
title	String	N	标题
sceneId	String	Y	场景id
coverUrl	String	N	封面地址
authorizeStatus	Integer	N	授权状态 0 未授权 1 已授权

示例：

{
    "taskType": "video-training",
    "data": {
        "result": "success",
        "coverUrl": "http://127.0.0.1/1898919683985883136.png",
        "reason": "",
        "createTime": 1741572705000,
        "sceneId": -287,
        "updateTime": 1741572739000,
        "id": 423,
        "authorizeStatus": 1,
        "title": "test"
    }
}

# 响应参数（客户端接收回调请求后，返回如下参数）：

字段	类型	是否必须	备注
code	String	Y	返回的状态码，为0表示成功
success	Boolean	Y	成功/错误
message	String	Y	成功/错误的描述信息

示例：

{
    "code": "0",
   "success": true,
    "message": "请求成功"
}

# 3.3 极速形象克隆列表

接口地址： /openapi/video/v2/training/pageList?access_token=ae4dad61-0dc5-47ad-be20-c51245db2769

请求方式：POST

请求数据类型：application/json

响应数据类型：application/json

# 接口描述：

分页查询极速形象克隆列表。

# 请求参数：

字段	类型	是否必须	备注
page	Integer	Y	页数
size	Integer	Y	页大小

# 响应参数：

字段	类型	是否必须	备注
code	String	Y	返回的状态码，为0表示成功
success	Boolean	Y	成功/错误
message	String	Y	成功/错误的描述信息
data	Json	N	返回的JSONObject
pageSize	Integer	N	页大小
pageNo	Integer	N	页数
totalRecord	Integer	N	总数
records	List	N	记录列表
id	Integer	Y	ID
title	String	Y	标题
videoUrl	String	Y	训练视频地址
status	Integer	Y	训练状态 0或空-准备中 1训练中 2训练成功 3训练失败 4审核不通过
callbackStatus	Integer	Y	回调状态 0或空-初始态 1-回调成功 2-回调失败
comment	String	Y	备注
sceneId	Integer	Y	场景ID
coverUrl	String	Y	封面地址
authorizeStatus	String	Y	授权状态 0 未授权 1 已授权
createTime	String	Y	创建时间
updateTime	String	Y	更新时间

示例：

{
    "code": "0",
    "message": "请求成功",
    "success": true,
    "data": {
        "pageSize": 10,
        "pageNo": 1,
        "totalRecord": 2,
        "records": [
            {
                "id": 423,
                "title": "test",
                "videoUrl": "http://127.0.0.1/videos/pc_1738894568491_2.6.mp4",
                "status": 2,
                "callbackStatus": 2,
                "comment": "",
                "sceneId": -287,
                "authorizeStatus": 1,
                "createTime": "2025-03-10 10:11:45",
                "updateTime": "2025-03-10 10:16:24",
                "coverUrl": "http://127.0.0.1/images/1898919683985883136.png"
            }
        ]
    }
}

# 3.4 极速形象克隆详情

接口地址： /openapi/video/v2/training/get/{id}?access_token=ae4dad61-0dc5-47ad-be20-c51245db2769

请求方式：GET

请求数据类型：application/json

响应数据类型：application/json

# 接口描述：

查询单个极速形象克隆详情。

# 请求参数：

字段	类型	是否必须	备注
id	Integer	Y	训练ID，注：该参数拼接在路径中

# 响应参数：

字段	类型	是否必须	备注
code	String	Y	返回的状态码，为0表示成功
success	Boolean	Y	成功/错误
message	String	Y	成功/错误的描述信息
data	Json	N	返回的JSONObject
id	Integer	Y	ID
title	String	Y	标题
videoUrl	String	Y	训练视频地址
status	Integer	Y	训练状态 0或空-准备中 1训练中 2训练成功 3训练失败 4审核不通过
callbackStatus	Integer	Y	回调状态 0或空-初始态 1-回调成功 2-回调失败
comment	String	Y	备注
sceneId	Integer	Y	场景ID
coverUrl	String	Y	封面地址
authorizeStatus	Integer	Y	授权状态 0 未授权 1 已授权
createTime	String	Y	创建时间
updateTime	String	Y	更新时间

示例：

{
    "code": "0",
    "message": "请求成功",
    "success": true,
    "data": {
        "id": 423,
        "title": "test",
         "videoUrl": "http://127.0.0.1/videos/pc_1738894568491_2.6.mp4",
         "status": 2,
         "callbackStatus": 2,
         "comment": "",
         "sceneId": -287,
         "authorizeStatus": 1,
         "createTime": "2025-03-10 10:11:45",
         "updateTime": "2025-03-10 10:16:24",
         "coverUrl": "http://127.0.0.1/images/1898919683985883136.png"
     }
 }

# 4. 极速声音克隆

# 4.1 极速声音克隆

接口地址：

/openapi/speaker/v3/clone?access_token=ae4dad61-0dc5-47ad-be20c51245db2769

请求方式：POST

请求数据类型：application/json

响应数据类型：application/json

# 接口描述：

提供了极速声音克隆的能力。

# 请求参数：

字段	类型	是否必须	备注
name	String	Y	声音名称
audioUrl	String	Y	音频素材地址（目前只支持wav格式）
authorizeUrl	String	Y	授权音频地址
authorizeText	String	Y	授权音频说话文本
sex	Integer	N	性别 1: 男，2：女
callbackUrl	String	N	回调地址

我们推荐您提供的音频素材符合以下规范:

类别	建议
音频时长	建议为10s~30s的音频。
录制环境	录音环境的选择主要考虑降低噪音和混响,建议使用10平方米以内的小房间进行录音,有吸音装置的房间是理想环境。可使用价格低廉的吸音棉对房间进行改造,目的是为了改变声波的平面反射为漫反射,降低混响。 1.尽量在同一声学环境下录制,避免过于喧哗的背景音和噪音,音频非拼接而成。 2.避免远场环境下录制,建议离麦克风50cm之内,并需要保持位置、距离稳定,防止音量大小不一致。不要让讲话的气流正对麦克风,防止喷麦造成的噪音。 3.尽量在自然对话状态下录制,对比刻意压低声线/呢喃获得的音色会更贴合本人。
音频质量	1.必须仅含有一个人在说话,避免多个人同时说话。 2.说话人发音及音质越清晰、复刻质量越高。如说话人喉音/声音底噪严重,则复刻音频喉音和底噪将会较为严重。 3.录音时需要保持音量大小、语速稳定、注意断句、避免口腔噪音(如口水声)、杂音、混响等情况。结合最终使用场景与人设加入适当演绎,避免朗读风格过于严重,并保持整体风格一致。 4.录音时尽量保持姿态稳定,减少不必要的肢体动作,椅子的响声、衣物的摩擦音、鼠标键盘的敲击声都是常见的人为噪声,需要格外注意细节。 5.如口误无需终止录音,可停顿1~2秒后,继续录制即可。文案中所有文字不必追求一字不落地完成,可以接受丢字、填字,保持语句通畅即可。
录制内容	建议在录音前熟悉文案,并确定好人设及演绎风格。尽量贴近复刻内容和主题,避免说话人韵律过于平淡,否则将得到较平的复刻效果。如需要复刻情绪韵律起伏较强的音频,请尽量输入表现力强的音频。尽量不要尝试复刻小孩或者老人的音频。

授权音频说话文本内容：我是XXX（真实姓名），同意授权硅基（guiji）智能，对我的声音进行克隆，用于声音合成。
授权说明：克隆主体姓名和授权主体公司为变量参数。

# 响应参数：

字段	类型	是否必须	备注
code	String	Y	返回的状态码，为0表示成功
success	Boolean	Y	成功/错误
message	String	Y	成功/错误的描述信息
data	Json	N	返回的JSONObject
speakerId	String	Y	声音id
ttsName	String	N	声音名称
ttsFeatures	String	N	声音特征
audioUrl	String	N	音频素材地址
ttsAudition	String	N	示例音频地址
languages	Array	N	支持的语种
sex	Integer	N	性别 1: 男，2：女
status	Integer	N	状态 0-准备中 1-训练中 2-训练成功 3-训练失败 4-已过期
authorizeStatus	Integer	N	授权状态 0 未授权 1 已授权
reason	String	N	失败原因
expireTime	String	N	过期时间

示例：

{
    "code": "0",
    "message": "请求成功",
    "success": true,
    "data": {
        "speakerId": "C_125",
        "ttsName": "tts-clone-test",
        "ttsFeatures": "原音色",
        "audioUrl": "https://localhost/test.wav",
        "ttsAudition": "",
        "languages": [
            "zh",
            "en"
        ],
        "sex": null,
        "status": 0,
        "authorizeStatus": 1,
        "reason": null,
        "expireTime": null
    }
}

# 4.2 极速声音克隆回调

接口地址：

用户提交极速声音克隆请求中的callback参数

请求方式：POST

请求数据类型：application/json

响应数据类型：application/json

# 接口描述：

用于开放平台回调通知客户端极速声音克隆的结果。

# 请求参数：

字段	类型	是否必须	备注
taskType	String	Y	值为"voice-clone"表示极速声音克隆回调
data	Json	Y	JSONObject
speakerId	String	Y	声音id
result	String	Y	success：成功, fail：失败
reason	String	N	失败原因
ttsName	String	N	声音名称
ttsFeatures	String	N	声音特征
audioUrl	String	N	音频素材地址
ttsAudition	String	N	示例音频地址
languages	Array	N	支持的语种
sex	Integer	N	性别 1: 男，2：女
status	Integer	Y	状态 0-准备中 1-训练中 2-训练成功 3-训练失败 4-已过期
authorizeStatus	Integer	N	授权状态 0 未授权 1 已授权
expireTime	String	N	过期时间

示例：

{
    "taskType": "voice-clone",
    "data": {
        "ttsName": "tts-clone-test",
        "result": "success",
        "audioUrl": "https://localhost/81aba4874293ee4eff4.wav",
        "expireTime": "2025-12-02 10:38:14",
        "languages": [
            "zh",
            "en"
        ],
        "speakerId": "C_126",
        "ttsFeatures": "原音色",
        "ttsAudition": "https://localhost/1E9uN4NJnoBJ.wav",
        "status": 2,
        "authorizeStatus": 1
    }
}

# 响应参数（客户端接收回调请求后，返回如下参数）：

字段	类型	是否必须	备注
code	String	Y	返回的状态码，为0表示成功
success	Boolean	Y	成功/错误
message	String	Y	成功/错误的描述信息

示例：

{
    "code": "0",
   "success": true,
    "message": "请求成功"
}

# 4.3 极速声音克隆列表

接口地址： /openapi/speaker/v2/clonePageList?access_token=ae4dad61-0dc5-47ad-be20-c51245db2769

请求方式：POST

请求数据类型：application/json

响应数据类型：application/json

# 接口描述：

分页查询极速声音克隆列表。

# 请求参数：

字段	类型	是否必须	备注
page	Integer	Y	页数
size	Integer	Y	页大小
sex	Integer	N	性别 1: 男，2：女
status	Integer	N	状态 0-准备中 1-训练中 2-训练成功 3-训练失败 4-已过期
expireStartTime	String	N	过期起始时间格式：yyyy-MM-dd HH:mm:ss
expireEndTime	String	N	过期结束时间格式：yyyy-MM-dd HH:mm:ss

# 响应参数：

字段	类型	是否必须	备注
code	String	Y	返回的状态码，为0表示成功
success	Boolean	Y	成功/错误
message	String	Y	成功/错误的描述信息
data	Json	N	返回的JSONObject
pageSize	Integer	N	页大小
pageNo	Integer	N	页数
totalRecord	Integer	N	总数
records	List	N	记录列表
speakerId	String	Y	声音id
ttsName	String	N	声音名称
ttsFeatures	String	N	声音特征
audioUrl	String	N	声音素材地址
ttsAudition	String	N	示例音频地址
languages	Array	N	支持的语种
sex	Integer	N	性别 1: 男，2：女
status	Integer	Y	状态 0-准备中 1-训练中 2-训练成功 3-训练失败 4-已过期
authorizeStatus	Integer	N	授权状态 0 未授权 1 已授权
reason	String	N	失败原因
expireTime	String	N	过期时间

示例：

{
    "code": "0",
    "message": "请求成功",
    "success": true,
    "data": {
        "pageSize": 2,
        "pageNo": 1,
        "totalRecord": 124,
        "records": [
            {
                "speakerId": "C_125",
                "ttsName": "tts-clone-test",
                "ttsFeatures": "原音色",
                "audioUrl": "https://localhost/test-ff4.wav",
                "ttsAudition": "https://localhost/3S6mp9H.wav",
                "languages": [
                    "zh",
                    "en"
                ],
                "sex": null,
                "status": 2,
                "authorizeStatus": 1,
                "reason": null,
                "expireTime": "2025-12-02 09:39:35"
            }
        ]
    }
}

# 4.4 极速声音克隆详情

接口地址：

/openapi/speaker/v2/clone/{speakerId}?access_token=ae4dad61-0dc5-47ad-be20-c51245db2769

请求方式：GET

请求数据类型：application/json

响应数据类型：application/json

# 接口描述：

查询单个极速声音克隆详情。

# 请求参数：

字段	类型	是否必须	备注
speakerId	String	Y	声音id，注：该参数拼接在路径中

# 响应参数：

字段	类型	是否必须	备注
code	String	Y	返回的状态码，为0表示成功
success	Boolean	Y	成功/错误
message	String	Y	成功/错误的描述信息
data	Json	N	返回的JSONObject
speakerId	String	Y	声音id
ttsName	String	N	声音名称
ttsFeatures	String	N	声音特征
audioUrl	String	N	声音素材地址
ttsAudition	String	N	示例音频地址
languages	Array	N	支持的语种
sex	Integer	N	性别 1: 男，2：女
status	Integer	Y	状态 0-准备中 1-训练中 2-训练成功 3-训练失败 4-已过期
authorizeStatus	Integer	N	授权状态 0 未授权 1 已授权
reason	String	N	失败原因
expireTime	String	N	过期时间

示例：

{
    "code": "0",
    "message": "请求成功",
    "success": true,
    "data": {
        "speakerId": "C_122",
        "ttsName": "tts-clone-test",
        "ttsFeatures": "原音色",
        "audioUrl": "https://localhost/93ee4eff4.wav",
        "ttsAudition": "https://localhost/WCSWhvXX51.wav",
        "languages": [
            "zh",
            "en"
        ],
        "sex": null,
        "status": 2,
        "authorizeStatus": 1,
        "reason": null,
        "expireTime": "2025-11-28 09:50:06"
    }
}

# 5. 视频合成

# 5.1 视频合成

接口地址：

/openapi/video/v3/simpleCreate?access_token=ae4dad61-0dc5-47ade20c51245db2769

请求方式：POST

请求数据类型：application/json

响应数据类型：application/json

# 接口描述：

提供了数字人视频合成的能力。

# 请求参数：

字段	类型	是否必须	备注
videoName	String	N	视频名称
sceneId	String	Y	场景id
audioUrl	String	N	音频地址（如果传值，优先用此音频驱动数字人视频合成）
text	String	N	文本（如果audioUrl为空，则使用此文本驱动数字人视频合成）
speakerId	String	N	声音id（audioUrl为空且text不为空时使用该声音id进行合成音频）
pn	Integer	N	循环合成规则：1-反向（默认），0-正向
callbackUrl	String	N	回调地址

# 响应参数：

字段	类型	是否必须	备注
code	String	Y	返回的状态码，为0表示成功
success	Boolean	Y	成功/错误
message	String	Y	成功/错误的描述信息
data	Json	N	返回的JSONObject
videoId	Integer	Y	视频合成id

示例：

{
    "code": "0",
    "message": "请求成功",
    "success": true,
    "data": {
        "videoId": -42
    }
}

# 5.2 视频合成回调

接口地址：

用户提交视频合成请求中的callback参数

请求方式：POST

请求数据类型：application/json

响应数据类型：application/json

# 接口描述：

用于开放平台回调通知客户端数字人视频合成的结果。

# 请求参数：

字段	类型	是否必须	备注
taskType	String	Y	值为"video-synthesis"表示视频合成回调
data	Json	Y	JSONObject
id	Integer	Y	视频合成id
videoName	String	N	视频名称
result	String	Y	success：成功, fail：失败
failReason	String	N	失败原因
videoUrl	String	N	视频地址
duration	String	N	时长(单位：秒，如11.32)
coverUrl	String	N	封面地址
createTime	Long	N	创建时间
updateTime	Long	N	更新时间

示例：

{
    "taskType": "video-synthesis",
    "data": {
        "duration": "22.75",
        "coverUrl": "http://127.0.0.1/imges/1216229666159992832_capFrame_2_1.jpg",
        "result": "success",
        "videoUrl": "http://127.0.0.1/videos/1216229666159992832_ff_1.mp4",
        "createTime": 1741578148000,
        "level": 1,
        "videoName": "test0310",
        "updateTime": 1741578148000,
        "id": -292,
        "synthesisStatus": 3
    }
}

# 响应参数（客户端接收回调请求后，返回如下参数）：

字段	类型	是否必须	备注
code	String	Y	返回的状态码，为0表示成功
success	Boolean	Y	成功/错误
message	String	Y	成功/错误的描述信息

示例：

{
    "code": "0",
   "success": true,
    "message": "请求成功"
}

# 5.3 视频合成列表

接口地址：

/openapi/video/v2/pageList?access_token=55d1bc37-f960-4a9d-8c7d-5dc8c991c245

请求方式：POST

请求数据类型：application/json

响应数据类型：application/json

# 接口描述：

分页查询用户视频合成列表。

# 请求参数：

字段	类型	是否必须	备注
page	Integer	Y	页数
size	Integer	Y	页大小

# 响应参数：

字段	类型	是否必须	备注
code	String	Y	返回的状态码，为0表示成功
success	Boolean	Y	成功/错误
message	String	Y	成功/错误的描述信息
data	Json	N	返回的JSONObject
pageSize	Integer	N	页大小
pageNo	Integer	N	页数
totalRecord	Integer	N	总数
records	List	N	记录列表
id	Integer	Y	视频合成id
videoName	String	N	视频名称
videoFormat	String	N	视频格式
synthesisStatus	Integer	N	合成状态：-1. 编辑中 1. 排队中 2. 合成中 3：合成成功 4：合成失败 6. 任务取消 7. 任务失败
videoUrl	String	N	视频地址
srtUrl	String	N	字幕地址
duration	String	N	时长(单位：秒)
durationMs	String	N	时长(单位：毫秒)
coverUrl	String	N	封面地址
createTime	String	N	创建时间
updateTime	String	N	更新时间
failReason	String	N	失败原因

示例：

{
    "code": "0",
    "message": "请求成功",
    "success": true,
    "data": {
        "pageSize": 10,
        "pageNo": 1,
        "totalRecord": 29,
        "records": [
            {
                "id": -291,
                "videoName": "test",
                "videoFormat": "mp4",
                "duration": "6.966",
                "durationMs": "6966",
                "coverUrl": "http://127.0.0.1/images/1741576636734.jpg",
                "videoUrl": "http://127.0.0.1/videos/1216222911489253376_ff_1.mp4",
                "srtUrl": "http://127.0.0.1/srts/VgAK5CxgtzBkBsR7.srt",
                "synthesisStatus": 3,
                "failReason": null,
                "createTime": "2025-03-10 11:15:33",
                "updateTime": "2025-03-10 11:17:17"
            }
        ]
    }
}

# 5.4 视频合成详情

接口地址：

/openapi/video/v2/get/{id}?access_token=ae4dad61-0dc5-47ad-be20-c51245db2769

请求方式：GET

请求数据类型：application/json

响应数据类型：application/json

# 接口描述：

查询用户视频合成详情。

# 请求参数：

字段	类型	是否必须	备注
id	Integer	Y	视频合成id，注：该参数拼接在路径中

# 响应参数：

字段	类型	是否必须	备注
code	String	Y	返回的状态码，为0表示成功
success	Boolean	Y	成功/错误
message	String	Y	成功/错误的描述信息
data	Json	N	返回的JSONObject
id	Integer	Y	视频合成id
videoName	String	N	视频名称
videoFormat	String	N	视频格式
synthesisStatus	Integer	N	合成状态：-1. 编辑中 1. 排队中 2. 合成中 3：合成成功 4：合成失败 6. 任务取消 7. 任务失败
videoUrl	String	N	视频地址
srtUrl	String	N	字幕地址
duration	String	N	时长(单位：秒)
durationMs	String	N	时长(单位：毫秒)
coverUrl	String	N	封面地址
createTime	String	N	创建时间
updateTime	String	N	更新时间
failReason	String	N	失败原因

示例：

{
    "code": "0",
    "message": "请求成功",
    "success": true,
    "data": {
        "id": -291,
        "videoName": "test",
        "videoFormat": "mp4",
        "duration": "6.966",
        "durationMs": "6966",
        "coverUrl": "http://127.0.0.1/images/1741576636734.jpg",
        "videoUrl": "http://127.0.0.1/videos/1216222911489253376_ff_1.mp4",
        "srtUrl": "http://127.0.0.1/srts/VgAK5CxgtzBkBsR7.srt",
        "synthesisStatus": 3,
        "failReason": null,
        "createTime": "2025-03-10 11:15:33",
        "updateTime": "2025-03-10 11:17:17"
    }
}

# 6. 音频合成

# 6.1 音频合成

接口地址：

/openapi/speaker/v3/fastTts?access_token=ae4dad61-0dc5-47ad-be20-c51245db2769

请求方式：POST

请求数据类型：application/json

响应数据类型：application/json

# 接口描述：

提供了音频合成的能力。

# 请求参数：

字段	类型	是否必须	备注
speakerId	String	Y	声音id
content	String	Y	文本
callbackUrl	String	N	回调地址

# 响应参数：

字段	类型	是否必须	备注
code	String	Y	返回的状态码，为0表示成功
success	Boolean	Y	成功/错误
message	String	Y	成功/错误的描述信息
data	Json	N	返回的JSONObject
id	Integer	Y	音频合成id
status	Integer	Y	状态：0-准备中，1-合成中，2-合成成功，3-合成失败

示例：

{
    "code": "0",
    "message": "请求成功",
    "success": true,
    "data": {
        "id": 202,
        "status": 0
    }
}

# 6.2 音频合成回调

接口地址：

用户提交音频合成请求中的callback参数

请求方式：POST

请求数据类型：application/json

响应数据类型：application/json

# 接口描述：

用于开放平台回调通知客户端音频合成的结果。

# 请求参数：

字段	类型	是否必须	备注
taskType	String	Y	值为"tts-synthesis"表示音频合成回调
data	Json	Y	JSONObject
id	Integer	Y	音频合成id
status	Integer	N	状态：0-准备中，1-合成中，2-合成成功，3-合成失败
duration	Integer	Y	音频时长单位：毫秒
ttsUrl	String	Y	音频地址

示例：

{
    "taskType": "tts-synthesis",
    "data": {
        "duration": 0,
        "ttsUrl": "http://127.0.0.1/wav/1.wav",
        "id": 1,
        "status": 2
    }
}

# 响应参数（客户端接收回调请求后，返回如下参数）：

字段	类型	是否必须	备注
code	String	Y	返回的状态码，为0表示成功
success	Boolean	Y	成功/错误
message	String	Y	成功/错误的描述信息

示例：

{
    "code": "0",
   "success": true,
    "message": "请求成功"
}

# 6.3 音频合成列表

接口地址：

/openapi/speaker/v2/tts/pageList?access_token=ae4dad61-0dc5-47ad-be20-c51245db2769

请求方式：POST

请求数据类型：application/json

响应数据类型：application/json

# 接口描述：

分页查询用户音频合成列表。

# 请求参数：

字段	类型	是否必须	备注
page	Integer	Y	页数
size	Integer	Y	页大小

# 响应参数：

字段	类型	是否必须	备注
code	String	Y	返回的状态码，为0表示成功
success	Boolean	Y	成功/错误
message	String	Y	成功/错误的描述信息
data	Json	N	返回的JSONObject
pageSize	Integer	N	页大小
pageNo	Integer	N	页数
totalRecord	Integer	N	总数
records	List	N	记录列表
id	Integer	Y	音频合成id
status	Integer	N	状态：0-准备中，1-合成中，2-合成成功，3-合成失败
duration	Integer	N	音频时长单位：毫秒
ttsUrl	String	N	音频地址
srtUrl	String	N	字幕地址

示例：

{
    "code": "0",
    "message": "请求成功",
    "success": true,
    "data": {
        "pageSize": 100,
        "pageNo": 1,
        "totalRecord": 2,
        "records": [
            {
                "id": 20,
                "ttsUrl": "http://127.0.0.1/1105667226071080960.wav",
                "srtUrl": "http://127.0.0.1/1105667226071080960.srt",
                "duration": 1539,
                "status": 2
            },
            {
                "id": 19,
                "ttsUrl": "http://127.0.0.1/1105667111205871616.wav",
                "srtUrl": "http://127.0.0.1/1105667111205871616.srt",
                "duration": 601,
                "status": 2
            }
        ]
    }
}

# 6.4 音频合成详情

接口地址：

/openapi/speaker/v2/tts/{id}?access_token=ae4dad61-0dc5-47ad-be20-c51245db2769

请求方式：GET

请求数据类型：application/json

响应数据类型：application/json

# 接口描述：

查询用户音频合成详情。

# 请求参数：

字段	类型	是否必须	备注
id	Integer	Y	音频合成id，注：该参数拼接在路径中

# 响应参数：

字段	类型	是否必须	备注
code	String	Y	返回的状态码，为0表示成功
success	Boolean	Y	成功/错误
message	String	Y	成功/错误的描述信息
data	Json	N	返回的JSONObject
id	Integer	Y	音频合成id
status	Integer	N	状态：0-准备中，1-合成中，2-合成成功，3-合成失败
duration	Integer	N	音频时长单位：毫秒
ttsUrl	String	N	音频地址
srtUrl	String	N	字幕地址

示例：

{
    "code": "0",
    "message": "请求成功",
    "success": true,
    "data": {
        "id": 17,
        "ttsUrl": "http://127.0.0.1/1104702054431072256.wav",
        "srtUrl": "http://127.0.0.1/1104702054431072256.srt",
        "duration": 2012,
        "status": 2
    }
}

# 7. 历史克隆数据授权

# 7.1 历史形象授权

接口地址：

/openapi/video/v3/authorize?access_token=ae4dad61-0dc5-47ad-be20-c51245db2769

请求方式：POST

请求数据类型：application/json

响应数据类型：application/json

# 接口描述：

存量形象授权。具体授权验证成功与否请使用3.4接口查询。

# 请求参数：

字段	类型	是否必须	备注
sceneId	Integer	Y	场景ID
authorizeUrl	String	Y	授权视频地址
authorizeText	String	Y	授权视频说话文本

# 响应参数：

字段	类型	是否必须	备注
code	String	Y	返回的状态码，为0表示成功
success	Boolean	Y	成功/错误
message	String	Y	成功/错误的描述信息
data	Boolean	N	返回的结果

示例：

{
    "code": "0",
    "message": "请求成功",
    "success": true,
    "data": true
}

# 7.2 历史声音授权

接口地址：

/openapi/speaker/v3/authorize?access_token=ae4dad61-0dc5-47ad-be20-c51245db2769

请求方式：POST

请求数据类型：application/json

响应数据类型：application/json

# 接口描述：

存量声音授权。具体授权验证成功与否请使用4.4接口查询。

# 请求参数：

字段	类型	是否必须	备注
speakerId	String	Y	发言人ID
authorizeUrl	String	Y	授权音频地址
authorizeText	String	Y	授权音频说话文本

# 响应参数：

字段	类型	是否必须	备注
code	String	Y	返回的状态码，为0表示成功
success	Boolean	Y	成功/错误
message	String	Y	成功/错误的描述信息
data	Boolean	N	返回的结果

示例：

{
    "code": "0",
    "message": "请求成功",
    "success": true,
    "data": true
}