tencent cloud

APIs

ドキュメントAPIsVideo on DemandMedia Processing APIsCreateAigcImageTask

CreateAigcImageTask

Download
フォーカスモード
フォントサイズ
最終更新日: 2026-05-19 15:01:56

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 will occur actual fee. Refer to the VOD AIGC image generation billing documentation (https://www.tencentcloud.com/document/product/266/95125?from_cn_redirect=1#9c4dc6ff-4b3f-4b25-bf2d-393889dfb9ac). The feature settlement mode is pay-as-you-go. Daily billing customers will be billed on the second day for usage on the day. Monthly billing customers will be billed on the 1st of the next month for usage in the previous 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. Customers who activate on-demand services from December 25, 2023 must fill this field with the application 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:

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

    Model version. Parameter value:

  • When ModelName is OG, available values are image2_low, image2_medium, image2_high;
  • When ModelName is GG, available values are 2.5, 3.0, 3.1;
  • When ModelName is Jimeng, available values are 4.0;
  • When ModelName is SI, available values are 4.0, 4.5, 5.0-lite;
  • When ModelName is Qwen, available values are 0925;
  • When ModelName is Hunyuan, available values are 3.0;
  • When ModelName is Vidu, available values are q2;
  • When ModelName is Kling, available values are 2.1, 3.0, 3.0-Omni, O1;
    		•
    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;
    • SI 4.0: 14;
    • SI 4.5: 14;
    • SI 5.0-lite: 14;
    • Vidu q2: 7;
    • Hunyuan 3.0: 3;
    • Qwen 0925: 1;
    • MJ v7: 3.
    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:

  • Enabled: Enable;
  • Disabled: Disable;

    		•
    OutputConfig No AigcImageOutputConfig

    Output media file configuration for the 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 as follows:

  • When ModelName is Hunyuan: 3d_panorama means Panoramic View;
  • Other ModelName is 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 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.

    • Hunyuan 3.0

      • Supports freely setting resolution width and height. Both width and height must be within [512, 2048] pixels, and the product of width and height must be ≤ 1024x1024 pixels. Example: {"AdditionalParameters": "{\"size\":\"728x1024\"}"}

    • SI series

      • Supports freely setting resolution width and height:
        • SI 4.0: Valid total pixel range [1280x720=921600, 4096x4096=16777216]. Example: {"AdditionalParameters": "{\"size\":\"728x1356\"}"}
        • SI 4.5: Valid total pixel range [2560x1440=3686400, 4096x4096=16777216]. Example: {"AdditionalParameters": "{\"size\":\"2560x1440\"}"}
        • SI 5.0-lite: Valid total pixel range [2560x1440=3686400, 3072x3072x1.1025=10404496]. Example: {"AdditionalParameters": "{\"size\":\"2560x1440\"}"}
      • Can be used to enable output of multiple images. Example: {"AdditionalParameters": "{\"sequential_image_generation\":\"auto\"}"}. Besides, the number of output images must be specified in Prompt, such as: output 3 images.

    • Qwen 0925

      • Supports freely setting resolution width and height. Valid total pixel range [512x512=261632, 2048x2048=4194304]. Example: {"AdditionalParameters": "{\"size\":\"728*1024\"}"}

    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

    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 Parameter error.
    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.
    前の記事へ: CreateAigcVideoTask次の記事へ: DescribeAigcApiTokens

    ヘルプとサポート

    この記事はお役に立ちましたか？

    フィードバック