tencent cloud

云点播

ModifyAIAnalysisTemplate

Download
聚焦模式
字号
最后更新时间: 2026-05-19 15:00:47

1. API Description

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

This API is used to modify a custom video content analysis template.

Note: templates with an ID below 10000 are preset and cannot be modified.

A maximum of 10 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: ModifyAIAnalysisTemplate.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
Definition Yes Integer Unique identifier of an audio and video content analysis template.
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 ClassificationConfigureInfoForUpdate Intelligent classification task control parameters.
TagConfigure No TagConfigureInfoForUpdate Intelligent tag task control parameter.
CoverConfigure No CoverConfigureInfoForUpdate Intelligent Cover Task Control Parameters.
FrameTagConfigure No FrameTagConfigureInfoForUpdate Intelligent frame tagging task control parameter.
HighlightConfigure No HighlightsConfigureInfoForUpdate Intelligent Highlights Compilation Task Control Parameters.

3. Output Parameters

Parameter Name Type Description
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 Disabling Intelligent Thumbnail Generation

This example shows you how to disable intelligent thumbnail generation in a custom audio and video analysis template.

Input Example

POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAIAnalysisTemplate
<Common request parameters>

{
    "Definition": 30,
    "CoverConfigure": {
        "Switch": "OFF"
    }
}

Output Example

{
    "Response": {
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

Example2 Enabling Intelligent Tagging and Disabling Intelligent Thumbnail Generation

This example shows you how to modify a custom audio and video content analysis template, enable intelligent tagging, and disable intelligent thumbnail generation.

Input Example

POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAIAnalysisTemplate
<Common request parameters>

{
    "TagConfigure": {
        "Switch": "ON"
    },
    "Definition": 30,
    "CoverConfigure": {
        "Switch": "OFF"
    }
}

Output Example

{
    "Response": {
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

Example3 Enabling Intelligent Thumbnail Generation

This example shows you how to enable intelligent thumbnail generation in a custom audio and video analysis template.

Input Example

POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAIAnalysisTemplate
<Common request parameters>

{
    "Definition": 30,
    "CoverConfigure": {
        "Switch": "ON"
    }
}

Output Example

{
    "Response": {
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

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
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.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.
ResourceNotFound The resource does not exist.
ResourceNotFound.TemplateNotExist The resource does not exist: the template does not exist.
UnauthorizedOperation Unauthorized operation.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈