1. 接口描述
接口请求域名: mps.tencentcloudapi.com 。
调用该接口用于创建AIGC生图片任务。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateAigcImageTask。 |
| Version | 是 | String | 公共参数,本接口取值:2019-06-12。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| ModelName | 否 | String | 模型名称。 示例值:GEM |
| ModelVersion | 否 | String | 指定模型特定版本号。默认使用系统当前所支持的模型稳定版本。
示例值:2.0 |
| Prompt | 否 | String | 生成图片的描述。(注:最大支持1000字符)。当未传入参考图片时,此参数必填。 示例值:draw a cat |
| NegativePrompt | 否 | String | 用于描述您想要阻止模型生成的内容。 注意:部分模型支持。 例如: 顶部照明、明亮的色彩 人物、动物 多辆汽车、风。 示例值:adult face |
| EnhancePrompt | 否 | Boolean | 默认取值为False,模型会严格地遵循指令。如果需要更精细的prompt获得最佳效果,可将此参数设置为True,将自动优化传入的prompt,以提升生成质量。 示例值:false |
| ImageInfos.N | 否 | Array of AigcImageInfo | 用于传入参考的资源图片信息,默认支持传入一张图片。 支持多图输入的模型:
注意:
|
| ExtraParameters | 否 | AigcImageExtraParam | 用于传入模型要求的额外参数。 |
| AdditionalParameters | 否 | String | 用于传入一些模型需要的特殊场景参数,Json格式序列化成字符串。 示例: {"size":"2048x2048"} 示例值:{"size":"2048x2048"} |
| StoreCosParam | 否 | AigcStoreCosParam | 文件结果指定存储Cos桶信息。 注意:需开通Cos,创建并授权MPS_QcsRole角色。 |
| Operator | 否 | String | 接口操作者名称。 示例值:admin |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 返回的任务ID。 示例值:4-AigcImage-c3b145ec76****94ac55b9e63be17d |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
POST / HTTP/1.1
Host:mps.tencentcloudapi.com
Content-Type:application/json
X-TC-Action: CreateAigcImageTask
<公共请求参数>
{
"Prompt": "draw a cat",
"Operator": "admin"
}
输出示例
{
"Response": {
"RequestId": "1047d0dc-6dc8-4898-a7f3-03726a822b0e",
"TaskId": "4-AigcImage-c3b145ec76****94ac55b9e63be17d"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.ViolationContent | 输入审核拦截。 |