BatchProcessMedia

Last updated: 2025-06-12 19:43:16Download PDF

1. API Description

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

This API is used to initiate batch processing tasks for URL video links, with features including:
Smart subtitle (full speech, speech hotword, and speech translation)

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: BatchProcessMedia.
Version	Yes	String	Common Params. The value used for this API: 2019-06-12.
Region	No	String	Common Params. This parameter is not required for this API.
InputInfo.N	Yes	Array of MediaInputInfo	Path of the input file.
OutputStorage	No	TaskOutputStorage	Storage bucket for the output file. If it is left blank, the storage location in InputInfo will be inherited. Note: When InputInfo.Type is URL, this parameter is required.
OutputDir	No	String	Storage directory for the output file. It should start and end with a slash (/), such as `/movie/201907/`. If left blank, it indicates that the directory is the same as the one where the file is located in InputInfo.
SmartSubtitlesTask	No	SmartSubtitlesTaskInput	Smart subtitle.
TaskNotifyConfig	No	TaskNotifyConfig	Event notification information of the task. If left blank, it indicates that no event notification will be obtained.
TasksPriority	No	Integer	Priority of the task flow. The higher the value, the higher the priority. The value range is from -10 to 10. If left blank, the default value is 0.
SessionContext	No	String	Source context, which is used to pass through the user request information. The callback for task flow status changes will return the value of this field. The maximum length is 1,000 characters.
ResourceId	No	String	Resource ID. Ensure the corresponding resource is in the enabled state. The default value is an account's primary resource ID.
SkipMateData	No	Integer	Whether to skip metadata acquisition. Valid values: 0: do not skip. 1: skip. Default value: 0

3. Output Parameters

Parameter Name	Type	Description
TaskId	String	Task ID.
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 Initiating a Task

Input Example

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

{
    "InputInfo": [
        {
            "Type": "URL",
            "UrlInputInfo": {
                "Url": "https://tetst-xxx-12xxxxx.cos.ap-xxxxx.myqcloud.com/processmedia/52.mp4"
            }
        }
    ],
    "OutputStorage": {
        "Type": "COS",
        "CosOutputStorage": {
            "Bucket": "tetst-xxxx-125xxxxx",
            "Region": "ap-xxxxx"
        }
    },
    "OutputDir": "/output/",
    "SmartSubtitlesTask": {
        "RawParameter": {
            "SubtitleType": 2,
            "VideoSrcLanguage": "zh",
            "SubtitleFormat": "vtt",
            "TranslateSwitch": "ON",
            "TranslateDstLanguage": "en"
        }
    },
    "TaskNotifyConfig": {
        "NotifyType": "URL",
        "NotifyUrl": "http://xxxx.com/v2/push/mps_test?token=73YcsZyP"
    },
    "SessionContext": "asdzxcs"
}

Output Example

{
    "Response": {
        "RequestId": "b30891cd-cdc7-47db-94d3-4dbb85641dad",
        "TaskId": "24000030-BatchTask-e6fefa34fc497449c1a043b9a594c7det20"
    }
}

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

Tencent Cloud CLI 3.0

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
FailedOperation.GenerateResource	Resource generation failed.
FailedOperation.InvalidMpsUser	Operation failed: unauthorized MPS user.
InternalError	Internal error.
InvalidParameter	Parameter error.
InvalidParameterValue.SessionContextTooLong	`SessionContext` is too long.
InvalidParameterValue.SessionId	The deduplication ID already exists. The request is removed due to duplication.
InvalidParameterValue.SessionIdTooLong	`SessionId` is too long.