Domain name for API request: vod.intl.tencentcloudapi.com.
Create a user-defined audio and video content analysis template. Maximum quantity: 50. HLS format not supported currently.
A maximum of 10 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: CreateAIAnalysisTemplate. |
| 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 | VOD application ID. Customers who activate VOD services after December 25, 2023 must fill this field with the application ID when accessing resources in on-demand applications (whether default or newly created). |
| Name | No | String | Audio and video content analysis template name. Length limit: 64 characters. |
| Comment | No | String | Audio/video content analysis template description. Length limit: 256 characters. |
| ClassificationConfigure | No | ClassificationConfigureInfo | Intelligent classification task control parameters. |
| TagConfigure | No | TagConfigureInfo | Intelligent tag task control parameter. |
| CoverConfigure | No | CoverConfigureInfo | Intelligent Cover Task Control Parameters. |
| FrameTagConfigure | No | FrameTagConfigureInfo | Intelligent frame tagging task control parameter. |
| HighlightConfigure | No | HighlightsConfigureInfo | Intelligent Highlights Compilation Task Control Parameters. |
| Parameter Name | Type | Description |
|---|---|---|
| Definition | Integer | Unique identifier of an audio and video content analysis template. |
| 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. |
This example shows you how to create a custom audio and video content analysis template with all intelligent analysis tasks enabled.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAIAnalysisTemplate
<Common request parameters>
{
"Comment": "Template 3",
"ClassificationConfigure": {
"Switch": "ON"
},
"Name": "Intelligent Analysis Template"
"TagConfigure": {
"Switch": "ON"
},
"FrameTagConfigure": {
"Switch": "ON",
"ScreenshotInterval": 0.5
},
"CoverConfigure": {
"Switch": "NO"
}
}
{
"Response": {
"Definition": 33,
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
This example shows you how to create a custom audio and video content analysis template with the intelligent classification task enabled.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAIAnalysisTemplate
<Common request parameters>
{
"Comment": "Template 1",
"ClassificationConfigure": {
"Switch": "ON"
},
"Name": "Intelligent Analysis Template"
}
{
"Response": {
"Definition": 30,
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
This example shows you how to create a custom audio and video content analysis template with intelligent classification and intelligent tag tasks enabled.
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAIAnalysisTemplate
<Common request parameters>
{
"Comment": "Template 2",
"TagConfigure": {
"Switch": "ON"
},
"ClassificationConfigure": {
"Switch": "ON"
},
"Name": "Intelligent Analysis Template"
}
{
"Response": {
"Definition": 31,
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
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 |
|---|---|
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue.ClassifcationConfigure | The control field parameter for intelligent categorization is incorrect. |
| InvalidParameterValue.Comment | Invalid parameter: template description. |
| InvalidParameterValue.CoverConfigure | The control field parameter for intelligent cover generation is incorrect. |
| InvalidParameterValue.Definition | Invalid parameter: Definition. |
| InvalidParameterValue.FrameTagConfigure | The control field parameter for intelligent frame-specific tagging is incorrect. |
| InvalidParameterValue.HighlightConfigure | Invalid intelligent highlight generating control parameter. |
| InvalidParameterValue.Name | Incorrect parameter value: Name exceeds the length limit. |
| InvalidParameterValue.TagConfigure | The control field parameter for intelligent tagging is incorrect. |
| LimitExceeded.TooMuchTemplate | Limit exceeded: The number of templates exceeds the upper limit of 100. If you need more, pleaseSubmit a ticket. |
| UnauthorizedOperation | Unauthorized operation. |
フィードバック