1. API Description

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

This API is used to create a custom transcoding template. Up to 1,000 templates can be created.

A maximum of 100 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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: CreateTranscodeTemplate.
VersionYesStringCommon Params. The value used for this API: 2019-06-12.
RegionNoStringCommon Params. This parameter is not required for this API.
ContainerYesStringContainer format. Valid values: mp4; flv; hls; mp3; flac; ogg; m4a. Among them, mp3, flac, ogg, and m4a are for audio files.
NameNoStringName of a transcoding template. Length limit: 64 characters.
CommentNoStringTemplate description. Length limit: 256 characters.
RemoveVideoNoIntegerWhether to remove video data. Valid values:
  • 0: Retain
  • 1: Remove

  • Default value: 0.
    RemoveAudioNoIntegerWhether to remove audio data. Valid values:
  • 0: Retain
  • 1: Remove

  • Default value: 0.
    VideoTemplateNoVideoTemplateInfoVideo stream configuration parameter. This field is required when RemoveVideo is 0.
    AudioTemplateNoAudioTemplateInfoAudio stream configuration parameter. This field is required when RemoveAudio is 0.
    TEHDConfigNoTEHDConfigTESHD transcoding parameter. To enable it, please contact your Tencent Cloud sales rep.
    EnhanceConfigNoEnhanceConfigAudio/Video enhancement configuration.

    3. Output Parameters

    Parameter NameTypeDescription
    DefinitionIntegerUnique ID of a transcoding template.
    RequestIdStringThe unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating a transcoding template

    Input Example

    POST / HTTP/1.1
    Host: mps.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateTranscodeTemplate
    <Common request parameters>
        "RemoveVideo": 0,
        "Container": "mp4",
        "Name": "test",
        "AudioTemplate": {
            "SampleRate": 44100,
            "Codec": "libfdk_aac",
            "Bitrate": 200
        "VideoTemplate": {
            "Codec": "libx264",
            "Bitrate": 256,
            "Fps": "45"
        "RemoveAudio": "0"

    Output Example

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

    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

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error CodeDescription
    FailedOperation.InvalidMpsUserOperation failed: unauthorized MPS user.
    InternalErrorInternal error.
    InternalError.AccessDBErrorData error.
    InvalidParameterValueIncorrect parameter value.
    InvalidParameterValue.AudioBitrateParameter error: Audio stream bitrate.
    InvalidParameterValue.AudioChannelIncorrect parameter value: AudioChannel.
    InvalidParameterValue.AudioCodecParameter error: audio stream codec.
    InvalidParameterValue.AudioSampleRateParameter error: audio stream sample rate.
    InvalidParameterValue.ContainerParameter error: container format.
    InvalidParameterValue.FpsParameter error: video frame rate.
    InvalidParameterValue.NameIncorrect parameter value: Name exceeds the length limit.
    InvalidParameterValue.RemoveAudioIncorrect parameter value: RemoveAudio.
    InvalidParameterValue.RemoveVideoIncorrect parameter value: RemoveVideo.
    InvalidParameterValue.ResolutionParameter error: Incorrect resolution.
    InvalidParameterValue.SampleRateInvalid audio sample rate.
    InvalidParameterValue.TEHDTypeIncorrect parameter value: invalid TEHD Type .
    InvalidParameterValue.TypeParameter error: incorrect Type value.
    InvalidParameterValue.VideoBitrateParameter error: video stream bitrate.
    InvalidParameterValue.VideoCodecParameter error: video stream codec.
    LimitExceeded.TooMuchTemplateLimit reached: the number of templates exceeds the limit.