CreateAigcImageTask
1. API Description
Domain name for API request: mps.intl.tencentcloudapi.com.
This API is used to create AIGC image generation tasks.
A maximum of 20 requests can be initiated per second for this API.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateAigcImageTask. |
| Version | Yes | String | Common Params. The value used for this API: 2019-06-12. |
| Region | No | String | Common Params. This parameter is not required. |
| ModelName | No | String | Model name. |
| ModelVersion | No | String | Specific version number of the model. By default, the system uses the supported stable version of the model.
|
| SceneType | No | String | Used for scene-based image generation; only supported by some models. Enumeration value:
|
| Prompt | No | String | Description of the generated image. This parameter is required when no reference image is specified. |
| NegativePrompt | No | String | Specifies the content you want to prevent the model from generating. Note: Not all models support this. For example: top lighting, bright colors, people, animals, multiple vehicles, and wind. |
| EnhancePrompt | No | Boolean | The default value is False, meaning the model follows instructions strictly. |
| ImageInfos.N | No | Array of AigcImageInfo | Reference resource images. By default, one image can be specified. Models supporting multiple images:
Note:
|
| ExtraParameters | No | AigcImageExtraParam | Additional parameters required for the model. |
| AdditionalParameters | No | String | Special scenario parameters required by the model, formatted as a JSON serialized string.
Example: {"size":"1024x1024"}. |
| StoreCosParam | No | AigcStoreCosParam | COS bucket information for the file result. Note: COS is required and the MPS_QcsRole role needs to be created and authorized. |
| Operator | No | String | API operator name. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | String | Returned task ID. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Request Example
Input Example
POST / HTTP/1.1
Host:mps.intl.tencentcloudapi.com
Content-Type:application/json
X-TC-Action: CreateAigcImageTask
<Common request parameters>
{
"Prompt": "draw a cat",
"Operator": "admin"
}
Output Example
{
"Response": {
"RequestId": "1047d0dc-6dc8-4898-a7f3-03726a822b0e",
"TaskId": "4-AigcImage-c3b145ec76****94ac55b9e63be17d"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameter.ViolationContent | Review blocklist for user-submitted input. |