tencent cloud

Video on Demand

DocumentationVideo on DemandServer APIsMedia Processing APIsCreateAigcVideoTask

CreateAigcVideoTask

Download
Focus Mode
Font Size
Last updated: 2026-05-19 15:01:54

1. API Description

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

This API is used to generate AIGC videos. The default limit is 1 concurrent processing. API calls will incur actual fees. Refer to the VOD AIGC video generation billing documentation (https://www.tencentcloud.com/document/product/266/95125?from_cn_redirect=1#96b3b59a-f9e1-49e9-966a-bedb70a4bf12). The feature settlement mode is pay-as-you-go. Daily billing customers will be charged on the second day for usage on the day, while monthly settlement 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: 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. Parameter Value:
Kling: Keling;
Vidu;
Hailuo: Hailuo;
Hunyuan: Hunyuan;
Mingmou: Mingmou;
GV;
OS;
PixVerse;
ModelVersion Yes String

Model version. Parameter Value:
When ModelName is Hailuo, optional values are 02, 2.3, and 2.3-fast.
When ModelName is Kling, optional values are 1.6, 2.0, 2.1, 2.5, 2.6, O1, 3.0, and 3.0-Omni.
When ModelName is Jimeng, optional value is 3.0pro.
When ModelName is Vidu, optional values are q2, q2-pro, q2-turbo, q3, q3-pro, and q3-turbo.
When ModelName is GV, optional values are 3.1 and 3.1-fast.
When ModelName is OS, optional value is 2.0.
When ModelName is Hunyuan, optional value is 1.5.
When ModelName is Mingmou, optional value is 1.0.
When ModelName is PixVerse, optional values are v5.6, v6, and c1.
FileInfos.N No Array of AigcVideoTaskInputFileInfo

Describes the resource file to be used by the model for video generation, divided into first and last frame mode, reference image, video reference, video editing, and other modes.

First and last frame video generation: The first frame supports only a single image, with the Usage field of the image set to FirstFrame. LastFrameFileId or LastFrameUrl represents the last frame. The first frame can be imported separately, but the last frame cannot. First and last frame generation refers to the image aspect ratio.
Reference image generation: Allows input of a single image or multiple images, with the Usage field of the image set to Reference. Reference images can adjust the aspect ratio of the generated video.
Video editing and video reference: Vidu and Kling can input a video as a reference or proceed with editing. Images can also be imported along with the video, with the Usage field of the image set to Reference.

Note:

  1. Image size should be no more than 10M.
  2. Supported image formats: jpeg, jpg, png. x0b
  3. To check whether a specific model version supports reference images, first and last frames, video editing, and other features, request the document from us or refer to the original document information.
SubjectInfos.N No Array of AigcVideoTaskInputSubjectInfo

Subject input information.
LastFrameFileId No String

Media file ID used as the last frame to generate video. This file's globally unique ID on VOD is assigned by the VOD backend after successful upload. You can retrieve this field in the video upload completion event notification or the VOD console.

  1. When specifying this parameter, you must simultaneously designate the first frame via FileInfos.
  2. Image size must be less than 10M.
  3. Image format value is: jpeg, jpg, png, webp.
LastFrameUrl No String

URL of the media file used as the last frame to generate video. Description:

  1. When you specify this parameter, you must also specify the first frame through FileInfos.
  2. Image size must be less than 5M.
  3. Image format value is: jpeg, jpg, png, webp.
Prompt No String

Prompt for video generation.
When no reference file is passed in, no usage scenario is specified, ExtInfo is not empty, Prompt is required.
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

    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 when special purpose.
    Can be used to input special parameters and storyboard prompts to the model.

    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 Parameter error.
    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.
    Previous Topic: CreateSceneAigcImageTaskNext Topic: CreateAigcImageTask

    Help and Support

    Was this page helpful?

    Help us improve! Rate your documentation experience in 5 mins.

    Feedback