1. 接口描述
接口请求域名: vod.tencentcloudapi.com 。
调用该接口,针对指定模型进行主体创建。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateAigcCustomElement。 |
| Version | 是 | String | 公共参数,本接口取值:2018-07-17。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| ElementName | 是 | String | 主体名称。不能超过20个字符 示例值:my element |
| ElementDescription | 是 | String | 主体描述。 不能超过100个字符。 示例值:description |
| ElementFrontalImage | 是 | String | 主体正面参考图。 支持传入图片URL(确保可访问) 图片格式支持.jpg / .jpeg / .png 图片文件大小不能超过10MB,图片宽高尺寸不小于300px,图片宽高比要在1:2.5 ~ 2.5:1之间。 示例值:http://my.image.com/element/pic.png |
| ElementReferList.N | 是 | Array of ElementReferInfo | 主体其他参考列表 可通过上传多张、不同角度的主体参考图来定义主体外观 至少上传1张参考图,至多上传3张参考图。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ElementId | String | 主体ID。需自行记录下返回的主体ID。 示例值:8543454323444234222 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type:application/json
X-TC-Action: CreateAigcCustomElement
<公共请求参数>
{
"ElementName": "my_element",
"ElementDescription": "主体",
"ElementFrontalImage": "https://****.vod-qcloud.com/6cd2c44bvodcq1500039**/179cafb25145403**1/ClcdjoxE6jcA.png",
"ElementReferList": [
{
"ImageUrl": "https://****.vod-qcloud.com/6cd2c44bvodcq1500039**/179cafb25145403**1/feefsfrefer.png"
}
]
}
输出示例
{
"Response": {
"RequestId": "1047d0dc-6dc8-4898-a7f3-03726a822b0e",
"ElementId": "53459345344333"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。