Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to create AIGC custom subjects (Vidu). Note that calling this API incurs fees. Refer to the billing documentation (https://www.tencentcloud.com/document/product/266/95125?from_cn_redirect=1#96b3b59a-f9e1-49e9-966a-bedb70a4bf12).
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: CreateAigcSubject. |
| 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 | No | Integer | Video-on-demand (VOD) application ID. For customers who activate VOD services from December 25, 2023, this field must be filled with the app ID when accessing resources in VOD applications (whether the default application or a newly created application). |
| SubjectName | No | String | Subject name. |
| SubjectImages.N | No | Array of String | Main image. Upload at least 1 main image. * Note 1: You can pass an image URL (make sure it is accessible); * Note 2: Input limit: 3 images; * Note 3: Supported formats: png, jpeg, jpg, webp; * Note 4: The image ratio must be less than 1:4 or 4:1; * Note 5: The image size must not exceed 50 MB; |
| SubjectVideos.N | No | Array of String | Video reference allows uploading 1 subject video
|
| VoiceId | No | String | Main voice type Id. This information is used only when creating an audio and video direct output task.
|
| 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 task 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 left blank, the default value is 0. |
| 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: CreateAigcSubject
<Common request parameters>
{
"SubAppId": 221073,
"SubjectName": "mySessionName",
"SubjectVideos": [
"***"
],
"SessionContext": "mySessionContext",
"TasksPriority": 10
}{
"Response": {
"TaskId": "221073-CreateAigcSubject-f9aa5a12**********cdd403de6fcd07t",
"RequestId": "e78603c5-2fd1-417a-91f5-023728963868"
}
}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 | Parameter error. |
| 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. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback