Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to generate AIGC images. The API is in beta. If needed, contact us. API calls will incur actual fees.
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: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| SubAppId | Yes | Integer | VOD application ID. Customers who activate on-demand services from December 25, 2023 must fill this field with the app ID when accessing resources in on-demand applications (whether it is the default application or a newly created application). |
| ModelName | Yes | String | Model name. Value: |
| ModelVersion | Yes | String | Model version. Parameter Value: |
| FileInfos.N | No | Array of AigcImageTaskInputFileInfo | File information of the input image for the AIGC image generation task. Only one is supported by default. The following models can accept multiple reference images: |
| Prompt | No | String | Prompt for image generation. This parameter is required when FileInfos is empty. |
| NegativePrompt | No | String | To prevent the model from generating image prompts. |
| EnhancePrompt | No | String | Whether to optimize Prompt content automatically. When Enabled, the passed in Prompt will be optimized automatically to enhance generation quality. Valid values: |
| OutputConfig | No | AigcImageOutputConfig | Output media file configuration for the image generation task. |
| InputRegion | No | String | Region information of the input file. When the file url is an overseas address, selectable Oversea. Default Mainland. |
| SceneType | No | String | |
| Seed | No | Integer | |
| SessionId | No | String | Identifier for deduplication. If a request with the same identifier has been sent within the past three days, an error is returned for the current request. The maximum length is 50 characters. If this is not specified or left empty, deduplication is not performed. |
| SessionContext | No | String | Source context. This is used to pass through user request information. The audio and video quality revival complete callback returns the value of this field. The maximum length is 1000 characters. |
| TasksPriority | No | Integer | Task priority. The higher the value, the higher the priority. The value range is from -10 to 10. If this is not specified, the default value is 0. |
| ExtInfo | No | String | Reserved field, used for special purpose. |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | String | 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: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAigcImageTask
<Common request parameters>
{
"SubAppId": 251007502,
"ModelName": "GEM",
"ModelVersion": "2.5",
"FileInfos": [
{
"FileId": "3704211***509819"
}
],
"Prompt": "generate a car",
"NegativePrompt": "red",
"EnhancePrompt": "Enabled",
"OutputConfig": {
"StorageMode": "Temporary",
"AspectRatio": "16:9",
"PersonGeneration": "AllowAdult",
"InputComplianceCheck": "Enabled",
"OutputComplianceCheck": "Enabled"
},
"SessionId": "mysession",
"SessionContext": "mySessionContext",
"TasksPriority": "10",
"ExtInfo": "myextinfo"
}
{
"Response": {
"TaskId": "251007502-AigcImage***2782aff1e896673f1ft",
"RequestId": "f50d7667-72d8-46bb-a7e3-0613588971b6"
}
}
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 |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.InvalidVodUser | The VOD service is not activated. |
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue.FileId | The FileId does not exist. |
| InvalidParameterValue.SessionContextTooLong | SessionContext is too long. |
| InvalidParameterValue.SessionId | The deduplication ID already exists. The request is removed due to duplication. |
| InvalidParameterValue.SessionIdTooLong | SessionId is too long. |
| InvalidParameterValue.SubAppId | Incorrect parameter value: application id. |
| UnauthorizedOperation | Unauthorized operation. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários