tencent cloud

SearchMediaBySemantics
Last updated: 2026-01-08 15:44:39
SearchMediaBySemantics
Last updated: 2026-01-08 15:44:39

1. API Description

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

This API is used to conduct semantic search on media using natural language.

A maximum of 20 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: SearchMediaBySemantics.
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 VOD application ID. for customers who activate on-demand services after december 25, 2023, this field must be filled with the application ID when accessing resources in on-demand applications (whether it's the default application or a newly created application).
Text Yes String Specifies the search content.
Limit No Integer Specifies the number of returned records. the default value is 20.
Categories.N No Array of String File type. matches any element in the collection:
  • Video: Video file
  • Audio: Audio file
  • Image: Image file
    • .
    Tags.N No Array of String Tag set, match any element in the collection.
  • single Tag length limit: 32 characters.
  • array length limit: 16.
    		•
    TaskTypes.N No Array of String Specifies the task type for the search. valid values:.
    - AiAnalysis.DescriptionTask
    - SmartSubtitle.AsrFullTextTask

    3. Output Parameters

    Parameter Name Type Description
    SearchResults Array of SemanticsSearchResult Media list.
    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

    Input Example

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

{
    "SubAppId": 1500035838,
    "Text": "A seaside video with sunset"
}

    Output Example

    {
    "Response": {
        "RequestId": "1e7aa7b9-0f92-4fbb-9ca2-6aebdfb31543",
        "SearchResults": [
            {
                "EndTimeOffset": 159.07,
                "FileId": "966263618841114024",
                "Score": 0.58276,
                "StartTimeOffset": 109.908
            },
            {
                "EndTimeOffset": 109.708,
                "FileId": "966263618841114024",
                "Score": 0.58201,
                "StartTimeOffset": 83.141
            },
            {
                "EndTimeOffset": 82.741,
                "FileId": "966263618841114024",
                "Score": 0.46496,
                "StartTimeOffset": 10.222
            }
        ]
    }
}

    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.
    ResourceNotFound.UserNotExist The user does not exist.
    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback