Face Effect

Last updated: 2025-09-09 20:02:18

Face Effect

Last updated: 2025-09-09 20:02:18

Feature Description
Face effects, providing beauty filter, face transformation, and portrait segmentation features.
Note:
This interface is a GET request and uses the synchronous request method. It requires carrying a signature. For specific signature settings, please see Request Signature.
Authorization Description
When used by a sub-account, the ci:FaceEffect permission is required. For details, see Cloud Infinite action.
Service Activation
Using this feature requires enabling Cloud Infinite in advance and binding a bucket. For details, see Bind Bucket.
Use this feature requires enabling AI Content Recognition Service in advance via console or API. For details, see Enable AI Content Recognition Service.
Use Limits
When using this API, please first confirm the relevant restrictions. For details, see Usage Limits.
The size of the image after base64 encoding must not exceed 5MB. Supports PNG, JPG, JPEG, BMP. Does not support GIF images.
When the type is face-segmentation, the image resolution must be less than 2000*2000.
Fee Description
This API is a paid service. Generated costs will be charged by Cloud Infinite. For detailed billing instructions, please refer to Content recognition.
﻿
Request
Request sample
Original image stored in COS:
GET /<ObjectKey>?ci-process=face-effect&type=<type> HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Original image comes from another link:
GET /?ci-process=face-effect&type=<type>&detect-url=<detect-url> HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Note:
Authorization: Auth String (See Request Signature document.)
Request parameters
Parameter Name
Required or Not
Type
Description
ObjectKey
Yes
String
object filename, such as folder/document.pdf
ci-process
Yes
String
Wanxiang processing capability Face effects fixed as face-effect
detect-url
No
String
You can process any publicly accessible image link by filling in detect-url. If detect-url is not filled in, the backend will default to processing ObjectKey. If detect-url is filled in, the backend will process the detect-url link, and there is no need to fill in ObjectKey.
http://www.example.com/abc.jpg needs to be url encoded, and the processed result is http%25253A%25252F%25252Fwww.example.com%25252Fabc.jpg.
type
Yes
String
Face effect types: face-beautify; face-gender-transformation; face-age-transformation; face-segmentation
whitening
No
Integer
This parameter is valid only when type is face-beautify. Whitening level, parameter value range [0,100]. 0 means no whitening, 100 represents the highest level. Default value is 30.
smoothing
No
Integer
This parameter is valid only when type is face-beautify. Skin smoothing level, parameter value range [0,100]. 0 means no smoothing, 100 represents the highest level. Default value is 10.
faceLifting
No
Integer
This parameter is valid only when type is face-beautify. Face slimming degree, parameter value range [0,100]. 0 means no slimming, 100 represents the highest level. Default value is 70.
eyeEnlarging
No
Integer
This parameter is valid only when type is face-beautify. Big eye level, parameter value range [0,100]. 0 means no big eyes, 100 represents the highest level. Default value is 70.
gender
No
Integer
This parameter is valid only when type is face-gender-transformation. Select the conversion direction: 0 for male-to-female, 1 for female-to-male. No default value, required option. Limitation: Only the largest human face in the image will be converted.
age
No
Integer
This parameter is valid only when type is face-age-transformation. The converted face age, [10,80]. No default value, required option. Limitation: Only the largest human face in the image will be converted.
Request header
Common Headers
This request uses common request headers. For details, see Common Request Headers.
Non-common Headers
This request has no special request header information.
Request body.
This request has no request body.
Response
Response Headers
Common Response Headers
This response contains common response headers. For details on common response headers, please refer to the Common Response Headers document.
Special Response Headers
There are no special response headers for this response operation.
Response Body
The response body is returned as application/xml. An example including the complete node data is shown below:
<Response>
  <ResultImage>
    base64-encoded image
  </ResultImage>
  <ResultMask>
    base64-encoded file
  </ResultMask>
</Response>
The data are as follows:
Node Name (Keyword)
Parent Node
Description
Type
Response
None.
Container for saving results
Container
The content of the Response
Node Name (Keyword)
Parent Node
Description
Type
ResultImage
Response
Processed image base64 data
String
ResultMask
Response
Portrait segmentation output parameters, a file encoded via Base64. After decoding, the file consists of float arrays. These floats represent each pixel point from the upper left corner of the original image, with each Float value being the grayscale value (0-255) converted from the confidence degree (0-1) of the corresponding pixel point within the human body contour.
String
Error Code
For common error messages, please refer to the Error Codes document.
Examples
Request
GET /test.jpg?ci-process=face-effect&type=face-beautify&whitening=70&smoothing=80&faceLifting=70&eyeEnlarging=70 HTTP/1.1
Authorization:q-sign-algorithm=sha1&q-ak=**********************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=**************************************
Host:bucket-1250000000.cos.ap-beijing.myqcloud.com
Response
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 414641
Date: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-image
x-cos-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhfMjc=
﻿
<Response>
  <ResultImage>
    Image (base64 encoding)
  </ResultImage>
</Response>
﻿

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

Parameter Name	Required or Not	Type	Description
ObjectKey	Yes	String	object filename, such as folder/document.pdf
ci-process	Yes	String	Wanxiang processing capability Face effects fixed as face-effect
detect-url	No	String	You can process any publicly accessible image link by filling in detect-url. If detect-url is not filled in, the backend will default to processing ObjectKey. If detect-url is filled in, the backend will process the detect-url link, and there is no need to fill in ObjectKey. `http://www.example.com/abc.jpg` needs to be url encoded, and the processed result is `http%25253A%25252F%25252Fwww.example.com%25252Fabc.jpg`.
type	Yes	String	Face effect types: face-beautify; face-gender-transformation; face-age-transformation; face-segmentation
whitening	No	Integer	This parameter is valid only when type is face-beautify. Whitening level, parameter value range [0,100]. 0 means no whitening, 100 represents the highest level. Default value is 30.
smoothing	No	Integer	This parameter is valid only when type is face-beautify. Skin smoothing level, parameter value range [0,100]. 0 means no smoothing, 100 represents the highest level. Default value is 10.
faceLifting	No	Integer	This parameter is valid only when type is face-beautify. Face slimming degree, parameter value range [0,100]. 0 means no slimming, 100 represents the highest level. Default value is 70.
eyeEnlarging	No	Integer	This parameter is valid only when type is face-beautify. Big eye level, parameter value range [0,100]. 0 means no big eyes, 100 represents the highest level. Default value is 70.
gender	No	Integer	This parameter is valid only when type is face-gender-transformation. Select the conversion direction: 0 for male-to-female, 1 for female-to-male. No default value, required option. Limitation: Only the largest human face in the image will be converted.
age	No	Integer	This parameter is valid only when type is face-age-transformation. The converted face age, [10,80]. No default value, required option. Limitation: Only the largest human face in the image will be converted.

Node Name (Keyword)	Parent Node	Description	Type
Response	None.	Container for saving results	Container

tencent cloud

Feature Description

Authorization Description

Service Activation

Use Limits

Fee Description

Request

Request sample

Request parameters

Request header

Common Headers

Non-common Headers

Request body.

Response

Response Headers

Common Response Headers

Special Response Headers

Response Body

Error Code

Examples

Request

Response