云点播创建 AIGC 高级自定义主体

1. 接口描述

接口请求域名： vod.tencentcloudapi.com 。

该接口用于创建 AIGC 高级自定义主体。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateAigcAdvancedCustomElement。
Version	是	String	公共参数，本接口取值：2018-07-17。
Region	否	String	公共参数，此参数为可选参数。
SubAppId	否	Integer	点播应用 ID。从2023年12月25日起开通点播的客户，如访问点播应用中的资源（无论是默认应用还是新创建的应用），必须将该字段填写为应用 ID。示例值：221073
ElementName	否	String	主体名称，不能超过20个字符。示例值：testname
ElementDescription	否	String	主体描述，不能超过100个字符。示例值：testdescription
ReferenceType	否	String	主体参考方式。通过视频定制的主体和通过图片定制的主体的可用范围不同。枚举值： video_refer：视频角色主体，此时将参考element_video_list定义主体外表。 image_refer：多图主体，此时将参考element_image_list定义主体外表。示例值：image_refer
ElementVoiceId	否	String	主体音色，可绑定音色库中已有音色。当前参数为空时，当前主体不绑定音色。仅视频定制的主体支持绑定音色。示例值：123333
ElementVideoList	否	String	主体参考视频，可通过视频设定主体及其细节。可上传有声视频，有声视频包含人声则触发音色定制（定制+入音色库+与主体绑定）参考视频时当前参数必填，参考图片时当前参数无效用key:value承载，如下： `{ "refer_videos":[ { "video_url":"video_url_1" } ]}` ● 视频格式仅支持MP4/MOV ● 仅支持时长介于3s～8s之间、宽高比例需为16:9或9:16的1080P视频 ● 至多仅支持上传1段视频，视频大小不超过200MB ● video_url参数值不得为空示例值：{"refer_videos":[{"video_url":"video_url_1"}]}
ElementImageList	否	String	主体参考图，可通过多张图片设定主体及其细节。包括正面参考图和其他角度或特写参考图，其中：至少包括1张正面参考图，由frontal_image参数定义。需包括1～3张其他参考图，需与正面参考图有差异，由image_url参数定义。用key:value承载，如下： `{ "frontal_image":"image_url_0", "refer_images":[ { "image_url":"image_url_1" }, { "image_url":"image_url_2" }, { "image_url":"image_url_3" } ]}` 示例值：{"frontal_image":"image_url_0","refer_images":[{"image_url":"image_url_1"},{"image_url":"image_url_2"},{"image_url":"image_url_3"}]}
TagList	否	String	为主体配置标签，一个主体可以配置多个标签。用key:value承载，其中具体如下： `[ { "tag_id": "o_101" }, { "tag_id": "o_102" }]` 示例值：[{"tag_id": "o_101"}, {"tag_id": "o_102"}]
SessionId	否	String	用于去重的识别码，如果三天内曾有过相同的识别码的请求，则本次的请求会返回错误。最长 50 个字符，不带或者带空字符串表示不做去重。示例值：mySessionId
SessionContext	否	String	来源上下文，用于透传用户请求信息，任务完成回调将返回该字段值，最长 1000 个字符。示例值：mySessionContext
TasksPriority	否	Integer	任务的优先级，数值越大优先级越高，取值范围是 -10 到 10，不填代表 0。示例值：10

3. 输出参数

参数名称	类型	描述
TaskId	String	任务 ID。示例值：221073-CreateAigcAdvancedCustomElement-927af0f45e354127835f6ec67c48f2a9t
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建多图主体

输入示例

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAigcAdvancedCustomElement
<公共请求参数>

{
    "SubAppId": 221073,
    "ElementName": "testname",
    "ElementDescription": "testdescription",
    "ReferenceType": "image_refer",
    "ElementVoiceId": "123333",
    "ElementImageList": "{\"frontal_image\":\"image_url_0\",\"refer_images\":[{\"image_url\":\"image_url_1\"},{\"image_url\":\"image_url_2\"},{\"image_url\":\"image_url_3\"}]}",
    "TagList": "[{\"tag_id\": \"o_101\"}, {\"tag_id\": \"o_102\"}]"
}

输出示例

{
    "Response": {
        "TaskId": "221073-CreateAigcAdvancedCustomElement-927af0f45e354127835f6ec67c48f2a9t",
        "RequestId": "2ff6980c-db91-488b-bb5b-04e8eb5661d2"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
FailedOperation.InvalidVodUser	没有开通点播业务。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue.SessionContextTooLong	SessionContext 过长。
InvalidParameterValue.SessionId	去重识别码重复，请求被去重。
InvalidParameterValue.SessionIdTooLong	SessionId 过长。
InvalidParameterValue.SubAppId	参数值错误：应用 ID。
UnauthorizedOperation	未授权操作。

创建 AIGC 高级自定义主体

本页目录：