tencent cloud

APIs

CreateAigcVideoTask

Download
Modo Foco
Tamanho da Fonte
Última atualização: 2026-05-11 19:48:35

1. API Description

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

This API is used to generate AIGC videos. 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: CreateAigcVideoTask.
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:

  • Hailuo: Hailuo;
  • Kling: Keling;
  • Jimeng: Jimeng;
  • Vidu;
  • Hunyuan: Hunyuan;
  • Mingmou: Mingmou;
  • ModelVersion Yes String

    Model version. Parameter Value:

  • When ModelName is Hailuo, optional values: 02, 2.3, and 2.3-fast;
  • When ModelName is Kling, optional values: 1.6, 2.0, 2.1, 2.5, and O1;
  • When ModelName is Jimeng, optional values: 3.0pro;
  • When ModelName is Vidu, optional values: q2, q2-pro, q2-turbo, q3-pro, and q3-turbo;
  • When ModelName is GV, optional values: 3.1 and 3.1-fast;
  • When ModelName is OS, optional values: 2.0;
  • When ModelName is Hunyuan, optional values: 1.5;
  • When ModelName is Mingmou, optional values: 1.0;
  • FileInfos.N No Array of AigcVideoTaskInputFileInfo

    A list of up to three material resource files for description of the resource files to be used by the model to generate video.

    Video generation for first and last frame: use the first table in FileInfos to represent the first frame (at this time FileInfos contains at most one image), and LastFrameFileId or LastFrameUrl to represent the last frame.

    Models that support multi-image input:

    1. GV: when entering multiple images, LastFrameFileId and LastFrameUrl are unavailable.
    2. Vidu: supports video generation with multiple image references. For q2 model, 1-7 images can be imported as the subject id via ObjectId in FileInfos.

    Note:

    1. Image size should not exceed 10M.
    2. Supported image formats: jpeg, png.
    SubjectInfos.N No Array of AigcVideoTaskInputSubjectInfo

    Fixed entity input information.

    LastFrameFileId No String

    Media file ID used as the tail frame to generate video. This file has a globally unique ID assigned by the VOD backend after successful upload. You can obtain this field in the video upload completion event notification or the VOD console. Description:

    1. Only models GV, Kling, and Vidu are supported. Other models are not currently supported. When ModelName is GV, if you specify this parameter, you must simultaneously specify FileInfos as the head frame of the video to be generated. When ModelName is Kling, ModelVersion is 2.1, and the output resolution Resolution is specified as 1080P, you can specify this parameter. When ModelName is Vidu and ModelVersion is q2-pro or q2-turbo, you can specify this parameter.
    2. Image size must be less than 5M.
    3. Image format value is: jpeg, jpg, png, webp.
    LastFrameUrl No String

    Media file URL used as the tail frame to generate video. Description:

    1. Only support models GV, Kling, and Vidu. Other models are not currently supported. When ModelName is GV, if you specify this parameter, you must simultaneously specify FileInfos as the head frame for video generation. When ModelName is Kling, ModelVersion is 2.1, and output resolution Resolution is specified as 1080P, you can specify this parameter. When ModelName is Vidu and ModelVersion is q2-pro or q2-turbo, you can specify this parameter.
    2. Image size must be less than 5M.
      1. Image format value: jpeg, jpg, png, webp.
    Prompt No String

    Prompt for video generation. This parameter is required when FileInfos is empty.
    Example value: move the picture

    NegativePrompt No String

    To prevent the model from generating video 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 AigcVideoOutputConfig

    Output media file configuration for the video 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

    Scenario type. Values are as follows:

  • When ModelName is Kling: motion_control means action control; avatar_i2v means digital human; lip_sync means lip-sync;
  • When ModelName is Vidu: template_effect means special effect Template;
  • Other ModelNames are not currently supported.
  • 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.

    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 Task of Generating AIGC Video

    Input Example

    POST / HTTP/1.1
    Host: vod.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateAigcVideoTask
    <Common request parameters>
    
    {
        "SubAppId": 251007502,
        "ModelName": "GV",
        "ModelVersion": "3.1-fast",
        "FileInfos": [
            {
                "FileId": "3704211***509819"
            }
        ],
        "LastFrameFileId": "3704211***509911",
        "Prompt": "generate a car",
        "NegativePrompt": "red",
        "EnhancePrompt": "Enabled",
        "OutputConfig": {
            "StorageMode": "Temporary",
            "AspectRatio": "9:16",
            "AudioGeneration": "Enabled",
            "PersonGeneration": "AllowAdult",
            "InputComplianceCheck": "Enabled",
            "OutputComplianceCheck": "Enabled"
        },
        "SessionId": "mysession2",
        "SessionContext": "mysessionContext",
        "TasksPriority": "10",
        "ExtInfo": "myextinfo"
    }
    

    Output Example

    {
        "Response": {
            "TaskId": "251007502-AigcVideo***25dacdcef7dd2b20fdt",
            "RequestId": "d68920a4-c989-4afe-ac4d-2f06de99368e"
        }
    }
    

    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 Invalid parameter.
    InvalidParameterValue.FileId The FileId does not exist.
    InvalidParameterValue.SessionContextTooLong SessionContext is too long.
    InvalidParameterValue.SessionIdTooLong SessionId is too long.
    InvalidParameterValue.SubAppId Incorrect parameter value: application id.
    UnauthorizedOperation Unauthorized operation.

    Ajuda e Suporte

    Esta página foi útil?

    comentários