产品动态
公告
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.
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 | 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. |
| ModelName | Yes | String | Model name. valid values: |
| ModelVersion | Yes | String | Model version. parameter value: |
| FileInfos.N | No | Array of AigcVideoTaskInputFileInfo | List of up to three material resources for description of resource images to be used by the model in video generation. Video generation with first and last frame: use the first table in FileInfos to represent the first frame (FileInfos contains at most one image at this point). LastFrameFileId or LastFrameUrl represents the last frame. Model supporting multi-image input. 1. GV, when entering multiple images, LastFrameFileId and LastFrameUrl are unavailable. 2. Vidu supports multi-image reference for video generation. the q2 model accepts 1-7 images. use the ObjectId in FileInfos as the subject id for input. Note:. 1. Image size: the size should not exceed 10 mb. 2. supported image formats: jpeg, png. |
| LastFrameFileId | No | String | The media file ID used as the end frame to generate video. this file has a globally unique ID on vod, assigned by the vod backend after successful upload. you can get this field in the video upload completion event notification or 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 first frame of the video to be generated. when ModelName is Kling and ModelVersion is 2.1 and specify output Resolution Resolution 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: the size should be less than 5 mb. 3. image format value is jpeg, jpg, png, webp. |
| LastFrameUrl | No | String | Media file URL used as frames to generate video. 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 first frame of the video to be generated. when ModelName is Kling and ModelVersion is 2.1 and specify output Resolution Resolution 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: the size should be less than 5 mb. 3. image format value is jpeg, jpg, png, webp. |
| Prompt | No | String | Prompt content for video generation. this parameter is required when FileInfos is empty. Example value: move the picture. |
| NegativePrompt | No | String | 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: |
| OutputConfig | No | AigcVideoOutputConfig | Specifies the output media file configuration for the video 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. |
| InputRegion | No | String | Specifies the region information of the input image. when the image url is a foreign address, selectable Oversea. default Mainland. |
| 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. |
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"
}{
"Response": {
"TaskId": "251007502-AigcVideo***25dacdcef7dd2b20fdt",
"RequestId": "d68920a4-c989-4afe-ac4d-2f06de99368e"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
文档反馈