tencent cloud

APIs

CreateAIAnalysisTemplate

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-09-18 16:50:20

1. API Description

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

This API is used to create a user-defined audio and video content analysis template. Maximum quantity: 50. HLS format is not supported currently.

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: 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. For customers who activate VOD services after December 25, 2023, when accessing resources in VOD applications (whether the default application or a newly created application), this field must be set to the app ID.
Name No String Audio and video content analysis template name. Length limit: 64 characters.
Comment No String Description of the audio and video content analysis template, with a length limit of 256 characters.
ClassificationConfigure No ClassificationConfigureInfo Intelligent classification task control parameters.
TagConfigure No TagConfigureInfo Control parameter of an intelligent tag task.
CoverConfigure No CoverConfigureInfo Intelligent cover task control parameters.
FrameTagConfigure No FrameTagConfigureInfo Control parameter of the intelligent frame-specific tagging task.
HighlightConfigure No HighlightsConfigureInfo Control parameters for the intelligent highlights compilation task.

3. Output Parameters

Parameter Name Type Description
Definition Integer Audio and video content analysis template unique identifier.
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 Creating a Template with All Content Analysis Tasks Enabled

This example shows you how to create a custom audio and video content analysis template with all intelligent analysis tasks enabled.

Input Example

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"
    }
}

Output Example

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

Example2 Creating a Template to Specify an Analysis Task

This example shows you how to create a custom audio and video content analysis template with the intelligent categorization task enabled.

Input Example

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"
}

Output Example

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

Example3 Creating a Template to Specify Multiple Analysis Tasks

This example shows you how to create a custom audio and video content analysis template with the intelligent categorization and intelligent tag tasks enabled.

Input Example

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"
}

Output Example

{
    "Response": {
        "Definition": 31,
        "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 Intelligent classification control field parameter error.
InvalidParameterValue.Comment Parameter error: description of this template.
InvalidParameterValue.CoverConfigure Intelligent cover control field parameter error.
InvalidParameterValue.Definition Parameter error: Definition.
InvalidParameterValue.FrameTagConfigure Intelligent frame tagging control field parameter error.
InvalidParameterValue.HighlightConfigure Intelligent highlights control parameter error.
InvalidParameterValue.Name Parameter value error: Name exceeds the length limit.
InvalidParameterValue.TagConfigure Intelligent tag control field parameter error.
LimitExceeded.TooMuchTemplate Exceed the limit: The number of templates exceeds the upper limit of 100. If needed, submit a ticket (https://console.tencentcloud.com/workorder/category).
UnauthorizedOperation Unauthorized operation.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan