CreateSceneAigcImageTask

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

CreateSceneAigcImageTask

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

1. API Description

Domain name for API request: vod.intl.tencentcloudapi.com.

This API is used to generate scenario-based AIGC images. This interface is in beta. If you need to use it, please 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: CreateSceneAigcImageTask.
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.
SceneInfo	Yes	AigcImageSceneInfo	Scenario-Based image generation parameter configuration.
FileInfos.N	No	Array of SceneAigcImageTaskInputFileInfo	Input image list. supported image formats: jpg, jpeg, png, webp. different scenarios require different input data. - AI clothing change scenario: input only 1 model image. - AI product image scenario: manually input 1-10 images of different angles per product.
OutputConfig	No	SceneAigcImageOutputConfig	Specifies the output media file configuration for the scenario-based image 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, up to 1000 characters.
TasksPriority	No	Integer	Task priority. the higher the value, the higher the priority. the value range is from -10 to 10. if left blank, the default value is 0.
ExtInfo	No	String	Reserved field, used for 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 Trigger a Scenario-Based AIGC Image Generation Task

Input Example

POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSceneAigcImageTask
<Common request parameters>

{
    "SubAppId": 251440382,
    "SceneInfo": {
        "Type": "change_clothes",
        "ChangeClothesConfig": {
            "ClothesFileInfos": [
                {
                    "FileId": "3704211***509819"
                }
            ]
        }
    },
    "FileInfos": [
        {
            "FileId": "3704211***509820"
        }
    ],
    "OutputConfig": {
        "StorageMode": "Temporary",
        "MediaName": "myfile",
        "ClassId": 0
    },
    "SessionId": "mysession",
    "SessionContext": "mySessionContext",
    "TasksPriority": 10,
    "ExtInfo": "myextinfo"
}

Output Example

{
    "Response": {
        "RequestId": "3185a050-c13a-4119-83a2-ed55802034c7",
        "TaskId": "251440382-SceneAigcImageTask-*****8a5d76bcacaaec9a6d823e4t"
    }
}

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