1. 接口描述
接口请求域名： live.tencentcloudapi.com 。
调用该接口，用于创建数字人直播间/AIGC直播间话术。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateLiveAvatarCloneFigure。 |
| Version | 是 | String | 公共参数，本接口取值：2018-08-01。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| SceneType | 是 | String | 形象克隆场景类型 枚举值：
示例值：PHOTO |
| FigureName | 是 | String | 克隆的形象的名字 示例值：电子女主播 |
| MaterialUrl | 是 | String | 克隆的形象的url 示例值：https://wsh-test-1303333058.cos.ap-guangzhou.myqcloud.com/%E7%94%B5%E5%AD%90%E4%BA%A7%E5%93%81%E5%A5%B3%E4%B8%BB%E6%92%AD.png |
| Gender | 否 | String | 克隆的形象的性别 枚举值：
示例值：FEMALE |
| IdentityWrittenUrl | 否 | String | 授权pdf 示例值：https://wsh-test-1303333058.cos.ap-guangzhou.myqcloud.com/%E6%95%B0%E5%AD%97%E4%BA%BA%E6%B5%8B%E8%AF%95/%E6%8E%88%E6%9D%83%E4%B9%A6-%E5%BC%A0%E4%B8%89V1.pdf |
| IdentityVideoUrl | 否 | String | 授权视频 示例值：https://virtualhuman-cos-prod-1251316161.cos.accelerate.myqcloud.com/customer-pipeline/3397/e0db4b1e-11be-480c-994a-88f06d44d87e/idcard/identity_7501541565984051200.pdf |
| PhotoVersion | 否 | Integer | 图生视频时，动作训练幅度大小 枚举值：
示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 该图克隆形象生成的任务id 示例值：7501977621938212864 |
| Status | String | 该克隆形象返回的状态 枚举值：
示例值：SUBMITTING |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建图片形象克隆
输入示例
POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLiveAvatarCloneFigure
<公共请求参数>
{
"SceneType": "PHOTO",
"FigureName": "电子女主播",
"MaterialUrl": "https://wsh-test-1303333058.cos.ap-guangzhou.myqcloud.com/%E7%94%B5%E5%AD%90%E4%BA%A7%E5%93%81%E5%A5%B3%E4%B8%BB%E6%92%AD.png",
"Gender": "FEMALE"
}输出示例
{
"Response": {
"Status": "SUBMITTING",
"TaskId": "7501977621938212864",
"RequestId": "08bdc698-230c-491a-a302-520d7eb57b3f"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
