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.
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 | Specify the model version number. By default, the system uses the supported stable version of the model.
|
| Prompt | No | String | Description of the generated image. (Note: Supports up to 1000 characters.) This parameter is required when no reference image is passed in. |
| 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. For better results with more nuanced prompts, set this parameter to True to automatically optimize the input prompt and improve generation quality. |
| ImageInfos.N | No | Array of AigcImageInfo | Used for inputting image information as a resource for reference. Default support for inputting an image. Models supporting multi-image input:
Note:
|
| ExtraParameters | No | AigcImageExtraParam | Additional parameters required for the model. |
| AdditionalParameters | No | String | Used to input some special scene parameters required by the model, serialized into a string in Json format. Example: {"size":"2048x2048"} |
| 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. |
| 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. |
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"
}
{
"Response": {
"RequestId": "1047d0dc-6dc8-4898-a7f3-03726a822b0e",
"TaskId": "4-AigcImage-c3b145ec76****94ac55b9e63be17d"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
文档反馈