tencent cloud



Last updated: 2024-03-27 16:09:32

    1. API Description

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

    Enhance Media By Template.

    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: EnhanceMediaByTemplate.
    Version Yes String Common Params. The value used for this API: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    FileId Yes String File ID.
    Definition Yes Integer Enhance Media Template ID.
    SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    StartTimeOffset No Float Starting offset time, unit: seconds, leaving it blank means intercepting from the beginning of the video.
    EndTimeOffset No Float End offset time, unit: seconds, leaving it blank means intercepting to the end of the video.
    OutputConfig No RebuildMediaOutputConfig File configuration after Enhance.
    SessionId No String The identification code used for deduplication. If there is a request for the same identification code within three days, this request will return an error. The maximum length is 50 characters, without or with an empty string to indicate no deduplication.
    SessionContext No String Source context, used to transparently transmit user request information. The task flow status change callback will return the value of this field, which can be up to 1000 characters.
    TasksPriority No Integer The priority of the task. The larger the value, the higher the priority. The value range is -10 to 10. If left blank, it means 0.
    ExtInfo No String Reserved fields, used for special purposes.

    3. Output Parameters

    Parameter Name Type Description
    TaskId String The task ID of the Enhance Media. You can use this ID to query the status of the EnhanceMedia task.
    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 Enhance Media By Template

    Enhance Media By Template.

    Input Example

    POST / HTTP/1.1
    Host: vod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: EnhanceMediaByTemplate
    <Public Request Parameter>
        "FileId": "8312960950918954859",
        "Definition": 20001

    Output Example

        "Response": {
            "TaskId": "125xxx-RebuildMedia-75e45d323ffad76987112fafe2eb87dxxx",
            "RequestId": "ef5aae86-6eab-4cb3-9ebc-0979010b3f22"

    5. Developer Resources


    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

    There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support