ExtractBlindWatermark

Last updated: 2025-12-02 14:26:40Download PDF

1. API Description

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

This API is used to initiate a digital watermark extraction task for a video. The extraction result can be queried through DescribeTaskDetail.

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: ExtractBlindWatermark.
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.
Type	Yes	String	Digital watermark type. Valid values: blind-basic: basic copyright digital watermark; blind-abseq: ab sequence copyright digital watermark.
InputInfo	Yes	MediaInputInfo	File input information for the Media Processing Service (MPS) task.
TaskNotifyConfig	No	TaskNotifyConfig	Event notification information of the task. If it is left unspecified, it indicates that no event notification is obtained.
ExtractBlindWatermarkConfig	No	ExtractBlindWatermarkTaskConfig	Configuration of the digital watermark extraction task.
ResourceId	No	String	Resource ID. Ensure that the corresponding resource is enabled. The default value is the primary resource ID of the account.

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 Digital Watermark Extraction Task for a Video

This example shows you how to initiate a digital watermark extraction task for a video.

Input Example

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

{
    "Type": "blind-basic",
    "InputInfo": {
        "Type": "URL",
        "UrlInputInfo": {
            "Url": "http://test.cos.com/video.mp4"
        }
    },
    "ExtractBlindWatermarkConfig": {
        "SegmentDuration": 5000
    }
}

Output Example

{
    "Response": {
        "RequestId": "2134541-fdc5-4b08-bf2d-97f7d6678b44",
        "TaskId": "24000105-ExtractBlindWatermark-xxxxxx"
    }
}

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.InvalidMpsUser	Operation failed: unauthorized MPS user.
InternalError	Internal error.
InvalidParameterValue	Incorrect parameter value.
InvalidParameterValue.SrcFile	Source file error.