ProcessImage

Last updated: 2025-10-13 10:33:59Download PDF

1. API Description

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

This API is used to initiate image processing, with features including:

Format conversion.
Image enhancement.
Image erasure.

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: ProcessImage.
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	Yes	MediaInputInfo	File input information for image processing.
OutputStorage	No	TaskOutputStorage	Target storage for image processing output files. If left blank, it inherits the storage location in InputInfo.
OutputDir	No	String	Output file path for image processing. If left blank, it is the directory of the file in InputInfo. If it is a directory, such as `/image/201907/`, it means inheriting the original filename and outputting to this directory.
OutputPath	No	String	Output path, which can be a relative or an absolute path. The path must end with `.{format}`. For details, please refer to the Filename Variable. Relative path example: `Filename_{Variablename}.{format}`. `Filename.{format}`. Absolute path example: `/Path/Filename_{Variablename}.{format}`. If not filled in, default relative path: `{inputName}.{format}`.
ImageTask	No	ImageTaskInput	Image processing parameter.

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 Image Enhancement

This example shows you how to initiate image enhancement.

Input Example

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

{
    "InputInfo": {
        "Type": "COS",
        "CosInputInfo": {
            "Bucket": "bucket-test",
            "Region": "ap-shanghai",
            "Object": "/image/test.png"
        }
    },
    "OutputStorage": {
        "Type": "COS",
        "CosOutputStorage": {
            "Bucket": "bucket-test",
            "Region": "ap-shanghai"
        }
    },
    "ImageTask": {
        "EncodeConfig": {
            "Format": "jpeg",
            "Quality": 75
        },
        "EnhanceConfig": {
            "SuperResolution": {
                "Switch": "ON"
            }
        }
    }
}

Output Example

{
    "Response": {
        "RequestId": "03b25aab-8883-497e-838f-d760c3e220f6",
        "TaskId": "3pg2p4jEfbFHYo2rgB0Kzl0esg4NeBItcZyllxO4HNJXdNeRUhk9GjDMjCj1auPv"
    }
}

Example2 Initiating an Image Erasure

This example shows you how to initiate an image erasure.

Input Example

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

{
    "InputInfo": {
        "Type": "COS",
        "CosInputInfo": {
            "Bucket": "bucket-test",
            "Region": "ap-shanghai",
            "Object": "/image/test.png"
        }
    },
    "OutputStorage": {
        "Type": "COS",
        "CosOutputStorage": {
            "Bucket": "bucket-test",
            "Region": "ap-shanghai"
        }
    },
    "ImageTask": {
        "EncodeConfig": {
            "Format": "jpeg",
            "Quality": 75
        },
        "EraseConfig": {
            "ImageEraseLogo": {
                "Switch": "ON",
                "ImageAreaBoxes": [
                    {
                        "Type": "logo",
                        "AreaCoordSet": [
                            101,
                            85,
                            111,
                            95
                        ]
                    }
                ]
            }
        }
    }
}

Output Example

{
    "Response": {
        "RequestId": "03b25aab-8883-497e-838f-d760c3e220f6",
        "TaskId": "3pg2p4jEfbFHYo2rgB0Kzl0esg4NeBItcZyllxO4HNJXdNeRUhk9GjDMjCj1auPv"
    }
}

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.
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.