CreateAigcImageTask

Last updated:2026-01-14 20:59:12

CreateAigcImageTask

Last updated: 2026-01-14 20:59:12

1. API Description

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.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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: 2018-07-17.
Region	No	String	Common Params. This parameter is not required.
SubAppId	Yes	Integer	The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
ModelName	Yes	String	Model name. valid values:. GEM:Gemini; Qwen: qianwen. Hunyuan: hunyuan.
ModelVersion	Yes	String	Model version. valid values:. When ModelName is GEM, optional values are 2.5, 3.0; When ModelName is Qwen, optional values are 0925. When ModelName is Hunyuan, the optional values are 3.0.
FileInfos.N	No	Array of AigcImageTaskInputFileInfo	File information of the input image for the AIGC image generation task. By default only one image can be specified; when using the GEM model, version 2.5 supports up to 3 images and version 3.0 supports up to 14 images.
Prompt	No	String	The prompt content for image generation. this parameter is required when FileInfos is empty.
NegativePrompt	No	String	Prevent the model from generating image generation prompts.
EnhancePrompt	No	String	Whether to optimize Prompt content automatically. when Enabled, it will optimize the passed in Prompt automatically to enhance generation quality. valid values: Enabled: turn on; Disabled: turn off;
OutputConfig	No	AigcImageOutputConfig	Output media file configuration for the task.
SessionId	No	String	An identifier for deduplication. if there has been a request with the same identifier within the past 3 days, an error will be returned for the current request. the maximum length is 50 characters. leaving it blank or using an empty string indicates no deduplication.
SessionContext	No	String	Source context, used to pass through user request information. the audio and video quality revival complete callback will return the value of this field. longest 1000 characters.
TasksPriority	No	Integer	Task priority. the higher the value, the higher the priority. value range is from -10 to 10. if left blank, the default value is 0.
ExtInfo	No	String	Reserved field, used when special purpose.

3. Output Parameters

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.

4. Example

Example1 Triggering the AIGC Image Generation Task

Input Example

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"
}

Output Example

{
    "Response": {
        "TaskId": "251007502-AigcImage***2782aff1e896673f1ft",
        "RequestId": "f50d7667-72d8-46bb-a7e3-0613588971b6"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

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
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.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud