tencent cloud

APIs

文档APIsVideo on DemandAI Creation APIsCreateAigcImageTask

CreateAigcImageTask

下载
聚焦模式
字号
最后更新时间： 2026-09-23 15:36:13

1. API Description

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

This API is used to generate AIGC images. The default limit is 1 concurrent processing. API calls incur actual fees. Refer to the VOD AIGC image generation billing documentation. The feature uses postpaid settlement mode. For daily billing customers, usage on the day is billed on the second day. For monthly settlement customers, the previous month's usage fees are billed on the 1st of the next month.

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

Video-on-demand (VOD) application ID. For customers who activate on-demand services from December 25, 2023, this field must be set to the app ID when accessing resources in on-demand applications (whether the default application or a newly created application).
ModelName Yes String

Model name. Parameter Value:

  • OG
  • GG
  • Hunyuan
  • Vidu
  • Kling
    		•
    ModelVersion Yes String

    Model version. Value:

  • When ModelName is OG, optional values: image2_low, image2_medium, image2_high;
  • When ModelName is GG, optional values: 2.5, 3.0, 3.1, 3.1-lite;
  • When ModelName is Hunyuan, optional values: 3.0, 3d_2.0, 3.5-preview;
  • When ModelName is Vidu, optional values: q2;
  • When ModelName is Kling, optional values: 2.1, 3.0, 3.0-Omni, O1, scene;
  • When ModelName is Mingmou, optional values: 1.0;
    		•
    FileInfos.N No Array of AigcImageTaskInputFileInfo

    File information of the input image for the AIGC image generation task. Maximum number of reference images supported by each model:

    • GG 2.5: 3
    • GG 3.0: 14
    • GG 3.1: 14
    • Kling 2.1: 4
    • Kling 3.0: 1
    • Kling 3.0-Omni: 10
    • Kling O1: 10
    • Vidu q2: 7
    • Hunyuan 3.0: 3
    Prompt No String

    Prompt for image generation. When FileInfos is empty, this parameter is required.
    NegativePrompt No String

    Prompt to prevent the model from image generation.
    EnhancePrompt No String

    Whether to optimize Prompt content automatically. When Enabled, the passed in Prompt content will be optimized automatically to enhance generation quality. Valid values:

  • Enabled: enable;
  • Disabled: disable;

    		•
    OutputConfig No AigcImageOutputConfig

    Output media file configuration for an image generation task.
    InputRegion No String

    Input region information. Available values:

    • Mainland: Chinese mainland;
    • Oversea: overseas;
    • OverseaUSWest: overseas - western United States;
    SceneType No String

    Scenario type. Values are as follows:

  • When ModelName is Hunyuan: 3d_panorama refers to panoramic view;
  • When ModelName is Kling: image_expand refers to image expansion;
  • Other ModelName values are not currently supported.
    		•
    Seed No Integer

    Random seed of the model.
    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 user request information. The audio and video quality revival completion 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 for special usage.

    • Hunyuan 3.0

      • Support setting resolution width and height freely. Both width and height are in the range of [512, 2048] pixels, and the product of width and height <= 1024x1024 pixels. Example: {"AdditionalParameters": "{"size":"728x1024"}"}

    • OG

      • Support setting resolution width and height freely:
        • Calculate the pixel size, which must be divisible by 16
        • The total pixels must be at least 655,360 and should not exceed 8,294,400
        • Example: {"AdditionalParameters": "{"size":"728x1024"}"}
      • Support setting a transparent layer:
        • Example: {"AdditionalParameters": "{"background":"transparent"}"}

    • Kling

      • Support setting expansion parameters. Example: {"AdditionalParameters":"{"down_expansion_ratio":0.2,"left_expansion_ratio":0.3,"right_expansion_ratio":0.4,"up_expansion_ratio":0.1}}
        • Common constraints:
          • Value range: [0, 2];
          • The overall area of the new image should not exceed 3 times that of the original image;
          • Forward Prompt content can be input through the Prompt field.
          • Example description:
            • up_expansion_ratio: expand upward, calculated based on a multiple of the original image height. If the original image height is 20 and the parameter value is 0.1, the distance from the top edge of the original image to the top edge of the new image is 20 x 0.1 = 2. This region is the expansion range.
            • down_expansion_ratio: expand downward, calculated based on a multiple of the original image height. If the original image height is 20 and the parameter value is 0.2, the distance from the bottom edge of the original image to the bottom edge of the new image is 20 x 0.2 = 4. This region is the expansion range.
            • left_expansion_ratio: expand to the left, calculated based on a multiple of the original image width. If the original image width is 30 and the parameter value is 0.3, the distance from the left edge of the original image to the left edge of the new image is 30 x 0.3 = 9. This region is the expansion range.
            • right_expansion_ratio: expand to the right, calculated based on a multiple of the original image width. If the original image width is 30 and the parameter value is 0.4, the distance from the right edge of the original image to the right edge of the new image is 30 x 0.4 = 12. This region is the expansion range.

    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 task to generate AIGC images

    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

    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 VOD service is not enabled.
    InternalError Internal error.
    InvalidParameter Parameter error.
    InvalidParameterValue.FileId FileId does not exist.
    InvalidParameterValue.SessionContextTooLong SessionContext is too long.
    InvalidParameterValue.SessionId Duplicate recognition code. Request deduplicated.
    InvalidParameterValue.SessionIdTooLong SessionId is too long.
    InvalidParameterValue.SubAppId Parameter value error: app ID.
    LimitExceeded.Quota The quota limit is exceeded.
    UnauthorizedOperation Unauthorized operation.
    上一篇: CreateAigcVideoTask下一篇: CreateAigcAudioTask

    帮助和支持

    本页内容是否解决了您的问题？

    填写满意度调查问卷，共创更好文档体验。

    文档反馈

    搜索
      请输入关键词搜索文档