1. 接口描述
接口请求域名: aiart.tencentcloudapi.com 。
表情动图生成接口将静态照片制作成动态的表情包。分为提交任务和查询任务2个接口。
- 提交任务:提交一个表情动图生成异步任务,获得任务 ID。
- 查询任务:根据任务 ID 查询任务的处理状态、处理结果,任务处理完成后可获得生成图像结果。
表情动图生成默认提供1个并发,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后才能开始处理下一个任务。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:SubmitMemeJob。 |
Version | 是 | String | 公共参数,本接口取值:2022-12-29。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Pose | 是 | String | 表情模板。 请在 表情动图模板列表 中选择期望的模板,传入 Pose 名称。 示例值:aiyobudeliao |
InputImage | 否 | String | 人像参考图 Base64 数据。 Base64 和 Url 必须提供一个,如果都提供以 Url 为准。 图片限制:单边分辨率小于5000,转成 Base64 字符串后小于 6MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。 示例值:9j/4QlQaHR0c...N6a2M5ZCI |
InputUrl | 否 | String | 人像参考图 Url。 Base64 和 Url 必须提供一个,如果都提供以 Url 为准。 图片限制:单边分辨率小于5000,转成 Base64 字符串后小于 6MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。 示例值:https://xxx.com/image.jpg |
Resolution | 否 | Integer | 生成分辨率。 真人类型支持256、512,默认为256, 卡通类型仅支持512。 示例值:256 |
Text | 否 | String | 自定义文案。 仅对真人类型的 Pose 生效,将在生成的表情动图中显示指定的文字。如果传入的字符串长度大于10,只截取前10个显示。 如果不传,默认使用自带的文案。 如果 text = "" 空字符串,代表不在表情动图中添加文案。 示例值:谢谢 |
Haircut | 否 | Boolean | 头发遮罩开关。 true:裁剪过长的头发。 false:不裁剪过长的头发。 仅对卡通类型的 Pose 生效,默认为 false。 示例值:false |
LogoAdd | 否 | Integer | 为生成结果图添加标识的开关,默认为1。 1:添加标识。 0:不添加标识。 其他数值:默认按1处理。 建议您使用显著标识来提示结果图是 AI 生成的图片。 示例值:1 |
LogoParam | 否 | LogoParam | 标识内容设置。 默认在生成结果图右下角添加“图片由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。 示例值:{"LogoUrl": "https://xxx.com/logo.jpg", "LogoRect": {"X": 10, "Y": 10, "Width": 20, "Height": 20}} |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
JobId | String | 任务id 示例值:string |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 调用示例
输入示例
POST / HTTP/1.1
Host: aiart.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitMemeJob
<公共请求参数>
{
"Pose": "aiyobudeliao",
"InputUrl": "https://xxx.com/image.jpg"
}
输出示例
{
"Response": {
"JobId": "251197749-1736402968-49025b63-ce50-11ef-9ce4-5254006b9705-0",
"RequestId": "97781219-f994-4169-b0a6-032b9fab4742"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。