# Alibaba Cloud Viapi Facebody API

> Alibaba Cloud Viapi Facebody API on Apizie: 44 endpoints (Describes the syntax and examples of the AddFace operation for adding face data, Describes the syntax and examples of the AddFaceEntity operation for adding face samples, Adds a face image template for face fusion by calling the AddFaceImageTemplate operation, This topic describes the syntax and examples of the BatchAddFaces operation for batch adding face data, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-facebody/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-facebody`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/facebody
- Page: https://zieapi.vercel.app/api/cloud/aliyun-facebody
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-facebody/openapi.json

Alibaba Cloud OpenAPI for Viapi Facebody (facebody, version 2019-12-30). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Describes the syntax and examples of the AddFace operation for adding face data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/add-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| DbName | string | yes | The database name. The name can contain lowercase letters, digits, and underscores (_), and must be 1 to 64 characters in length |
| ImageUrl | string | yes | The URL of the face image. The face must be a frontal, unobstructed face. If the image contains multiple faces, the largest face is added.… |
| EntityId | string | yes | The entity ID that uniquely identifies a user, such as a user ID or employee ID. Each entity can contain multiple face images. The ID can… |
| ExtraData | string | no | The custom information. The value can contain letters, digits, punctuation marks, and Chinese characters. The value cannot exceed 512… |
| QualityScoreThreshold | number | no | The quality score threshold. The system performs quality analysis on the new face image. If the quality score is less than this threshold,… |
| SimilarityScoreThresholdInEntity | number | no | The intra-entity similarity threshold. The system compares the new face image with existing faces within the specified EntityId. If the… |
| SimilarityScoreThresholdBetweenEntity | number | no | The inter-entity similarity threshold. The system compares the new face image with existing faces in all other EntityId entries. If the… |

### Describes the syntax and examples of the AddFaceEntity operation for adding face samples
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/add-face-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| DbName | string | yes | The name of the database |
| EntityId | string | yes | The entity ID. The value can contain digits, letters, and underscores |
| Labels | string | no | The custom labels. You can add up to 10 labels with a total length of no more than 1024 characters. The format requirements are as… |

### Adds a face image template for face fusion by calling the AddFaceImageTemplate operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/add-face-image-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the face template image. We recommend that you use an China (Shanghai) region OSS URL. If the file is stored locally or in an… |

### This topic describes the syntax and examples of the BatchAddFaces operation for batch adding face data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/batch-add-faces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| DbName | string | yes | The database name. The name can contain lowercase letters, digits, and underscores (_), and must be 1 to 64 characters in length |
| EntityId | string | yes | The entity ID, which uniquely identifies a user, such as a user ID or employee ID. Each entity can contain multiple face images. The ID… |
| SimilarityScoreThresholdInEntity | number | no | The intra-entity similarity threshold. The new face image is compared with existing faces within the specified EntityId. If the similarity… |
| SimilarityScoreThresholdBetweenEntity | number | no | The inter-entity similarity threshold. The new face image is compared with existing faces in all other EntityId entries. If the similarity… |
| Faces | string | yes | The face information (JSON-encoded) |
| QualityScoreThreshold | number | no | The quality score threshold. The new face image is analyzed for quality. If the quality score is less than this threshold, the face image… |

### Describes the syntax and examples of the BlurFace operation in the facebody category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/blur-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in other regions,… |

### Describes the syntax and examples of the BodyPosture operation in the facebody category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/body-posture` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. For files stored on your on-premises machine or… |

### Describes the syntax and examples of the CompareFace operation in the facebody category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/compare-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| QualityScoreThreshold | number | no | The quality score threshold. The system analyzes and evaluates the quality of the face images. If the quality score of a face is less than… |
| ImageURLA | string | no | The URL of Image A. We recommend that you use an OSS URL in the China (Shanghai) region. For files stored locally or in OSS buckets… |
| ImageURLB | string | no | The URL of Image B. We recommend that you use an OSS URL in the China (Shanghai) region. For files stored locally or in OSS buckets… |
| ImageDataA | string | no | The Base64-encoded string of Image A. If both the URL and Base64 encoding methods are used, the URL method takes precedence. For more… |
| ImageDataB | string | no | The Base64-encoded string of Image B. If both the URL and Base64 encoding methods are used, the URL method takes precedence. For more… |

### Describes the syntax and examples for the CompareFaceWithMask operation in the facebody category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/compare-face-with-mask` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| ImageURLA | string | yes | The URL of Image A. We recommend that you use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in other regions, see… |
| ImageURLB | string | yes | The URL of Image B. We recommend that you use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in other regions, see… |
| QualityScoreThreshold | number | no | The quality score threshold. The system analyzes and evaluates the quality of the face images. If the quality score of a face is less than… |

### This topic describes the syntax and examples of the CreateFaceDb operation for creating a face database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/create-face-db` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| Name | string | yes | The database name. The name can contain letters, digits, and underscores (_), and must be 1 to 64 characters in length |

### Describes the syntax and examples of the DeepfakeFace operation in the facebody category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/deepfake-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| Tasks | string | yes | The input face data (JSON-encoded) |

### Describes the syntax and provides examples for the DeleteFace operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/delete-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| DbName | string | yes | The name of the database |
| FaceId | string | yes | The ID of the face data |

### This topic describes the syntax and examples of the DeleteFaceDb operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/delete-face-db` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| Name | string | yes | The name of the database |

### This topic describes the syntax and examples of the DeleteFaceEntity operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/delete-face-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| DbName | string | yes | The name of the database |
| EntityId | string | yes | The entity ID, such as an employee ID. The value can contain digits, letters, and underscores |

### Describes the syntax and provides examples for the DeleteFaceImageTemplate operation for deleting face image…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/delete-face-image-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| TemplateId | string | yes | The ID of the template to delete |

### Describes the syntax and examples of the DetectBodyCount operation in the facebody category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/detect-body-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the image. Use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in other regions, see… |

### Describes the syntax and examples of the DetectCelebrity operation in the facebody category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/detect-celebrity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in regions other… |

### Detects faces and locates facial landmarks in an image
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/detect-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the image. An OSS URL in the China (Shanghai) region is recommended. For local files or OSS URLs in other regions, see… |
| Landmark | string | no | Specifies whether to return facial landmark localization results. Valid values: true and false |
| Quality | string | no | Specifies whether to return the face quality score. Valid values: true and false |
| Pose | string | no | Specifies whether to return the face pose. Valid values: true and false |
| MaxFaceNumber | integer | no | The maximum number of faces to return in the image. Valid values: 1 to 30. Set this parameter properly if you want to return multiple face… |

### This topic describes the syntax and examples of the DetectInfraredLivingFace operation for infrared face…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/detect-infrared-living-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| Tasks | string | yes | The URLs of the images to be detected (JSON-encoded) |

### Describes the syntax and examples of the DetectLivingFace operation in the facebody category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/detect-living-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| Tasks | string | yes | The input face data (JSON-encoded) |

### Describes the syntax and examples for the DetectPedestrian operation in the facebody category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/detect-pedestrian` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the image. An OSS URL in the China (Shanghai) region is recommended. For local files or OSS URLs in other regions, see… |

### Describes the syntax and examples of the DetectVideoLivingFace operation in the FaceBody category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/detect-video-living-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| VideoUrl | string | yes | The URL of the video in which you want to detect faces. We recommend that you use an OSS URL in the China (Shanghai) region. If the file… |

### Describes the syntax and examples of the EnhanceFace operation in the facebody category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/enhance-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. For files stored locally or in OSS buckets… |

### This topic describes the syntax and examples of the ExtractFingerPrint operation in the Face Body category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/extract-finger-print` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| ImageURL | string | no | The image URL. We recommend that you use an OSS URL in the China (Shanghai) region. For files stored locally or in OSS buckets outside the… |
| ImageData | string | no | The Base64-encoded string of the image. For more information about Base64 encoding, see… |

### Describes the syntax and examples of the FaceBeauty operation in the facebody category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/face-beauty` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the image. Use an OSS URL in the China (Shanghai) region. For files stored locally or in OSS buckets outside the China… |
| Sharp | number | yes | The sharpening (clarity) level. Valid values: 0 to 1. A value closer to 1 indicates a higher sharpening level |
| Smooth | number | yes | The smoothing level. Valid values: 0 to 1. A value closer to 1 indicates a higher smoothing level |
| White | number | yes | The skin whitening level. Valid values: 0 to 1. A value closer to 1 indicates a higher skin whitening level |

### Initiates a real-person identity verification request
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/gen-real-person-verification-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| CertificateName | string | yes | The name on the ID card to be verified |
| CertificateNumber | string | yes | The ID card number |
| MetaInfo | string | yes | The metainfo environment parameter, which must be obtained through the client SDK. For Android SDK, use getMetaInfos. For iOS SDK, use… |

### Describes the syntax and examples of the GenerateHumanAnimeStyle operation in the facebody category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/generate-human-anime-style` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The image URL. We recommend that you use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in other regions, see… |
| AlgoType | string | no | The configuration parameter for the cartoon effect. Valid values: anime: Japanese anime 3d: 3D effects handdrawn: hand-drawn sketch:… |

### Stylizes a human portrait into a sketch
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/generate-human-sketch-style` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The image URL. Use an OSS URL in the China (Shanghai) region. For files stored locally or in OSS buckets outside the China (Shanghai)… |
| ReturnType | string | no | The return format of the image. Valid values: head: headshot (default) full: full-body photo Use headshots for better processing results |

### This topic describes the syntax and examples of the GetFaceEntity operation for querying face samples
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/get-face-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| DbName | string | yes | The name of the database |
| EntityId | string | yes | The entity ID. The value can contain digits, letters, and underscores |

### This topic describes the syntax and examples of the GetRealPersonVerificationResult operation for querying…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/get-real-person-verification-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| VerificationToken | string | yes | The unique identifier of the trusted real-person verification. A VerificationToken that has already been verified cannot be queried again.… |

### Describes the syntax and examples of the LiquifyFace operation in the facebody category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/liquify-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the image. Use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in other regions, see… |
| SlimDegree | number | no | The standard intensity. Valid values: [0, 2.0]. Default value: 1.0. A larger value indicates a more obvious face slimming effect |

### This topic describes the syntax and examples of the ListFaceDbs operation for querying the list of face…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/list-face-dbs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| Offset | integer | no | The starting page number. Default value: 0. If you do not specify this parameter, data is returned starting from page 0 |
| Limit | integer | no | The maximum number of samples to display per page. Valid values: 1 to 200. Default value: 200 |

### This topic describes the syntax and examples of the ListFaceEntities operation for querying a list of face…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/list-face-entities` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| DbName | string | yes | The name of the database |
| Offset | integer | no | The start record. Valid values: 0 to 2000 |
| Limit | integer | no | The maximum number of samples to display per page. Valid values: 1 to 200 |
| Token | string | no | When the query results exceed 2000 records, use the Token returned from the previous request as a parameter to query the next page |
| Labels | string | no | The custom labels. A maximum of 10 labels are supported. Separate multiple labels with commas (,) |
| EntityIdPrefix | string | no | The prefix of the sample ID. The prefix can contain digits, letters, and underscores |
| Order | string | no | The sort order. Valid values: asc: ascending order. desc: descending order |

### Merges a face from a source image into a template image
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/merge-image-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| TemplateId | string | yes | The template ID of the face template. You must upload a template first. For more information, see… |
| ImageURL | string | no | The URL of the face photo to be merged. This parameter is used only when the template image contains a single person. An OSS URL in the… |
| ModelVersion | string | no | Provides two model versions that support face shape adaptation (v1) and non-face shape adaptation (v2) effects. Default value: v1 (the… |
| AddWatermark | string | no | Specifies whether to add a watermark. Valid values: False (default): Does not add a watermark. True: Adds a watermark |
| WatermarkType | string | no | The watermark type. Valid values: EN (default): English watermark. CN: Chinese watermark |
| MergeInfos | string | no | The MergeInfos (JSON-encoded) |

### Describes the syntax and examples of the MonitorExamination operation in the facebody category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/monitor-examination` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| Type | integer | yes | The detection type. Valid values: 0: Screen chat tool detection. 1: Candidate status detection |
| ImageURL | string | yes | The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. If the file is stored on your on-premises… |

### Describes the syntax and examples of the PedestrianDetectAttribute operation in the facebody category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/pedestrian-detect-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The image URL. We recommend that you use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in regions other than… |

### Queries face image templates for face fusion by calling the QueryFaceImageTemplate operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/query-face-image-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| TemplateId | string | no | The ID of the template to query. If TemplateId is not specified, the template list of the user is returned. If TemplateId is specified,… |
| PageNo | integer | no | The page number. Default value: 1. Valid values: 1 to 5000 |
| PageSize | integer | no | The number of entries per page. Default value: 100. Valid values: 1 to 500 |

### Describes the syntax and examples of the RecognizeAction operation in the face and body category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/recognize-action` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| Type | integer | yes | Specifies the input content type, which includes video and image. Valid values: 0: Indicates that the input is a video URL or a video… |
| VideoUrl | string | no | The URL of the video. This parameter is required when Type is set to 0. An OSS URL in the China (Shanghai) region is recommended. For… |
| URLList | string | no | The list of images (JSON-encoded) |
| VideoData | string | no | The Base64-encoded string of the video. If both this parameter and VideoUrl are specified, VideoUrl takes precedence. For more information… |

### Describes the syntax and examples of the RecognizeExpression operation in the facebody category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/recognize-expression` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in other regions,… |

### Recognizes face attributes
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/recognize-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the image. Use an OSS URL in the China (Shanghai) region. For local files or OSS URLs in other regions, see… |
| Age | string | no | Specifies whether to return the face age result. This parameter is compatible with the old version. Valid values: true and false. Default… |
| Gender | string | no | Specifies whether to return the face gender result. This parameter is compatible with the old version. Valid values: true and false.… |
| Hat | string | no | Specifies whether to return the hat result. This parameter is compatible with the old version. Valid values: true and false. Default… |
| Glass | string | no | Specifies whether to return the glasses result. This parameter is compatible with the old version. Valid values: true and false. Default… |
| Beauty | string | no | Specifies whether to return the beauty score result. This parameter is compatible with the old version. Valid values: true and false.… |
| Expression | string | no | Specifies whether to return the expression result. This parameter is compatible with the old version. Valid values: true and false.… |
| Mask | string | no | Specifies whether to return the mask result. This parameter is compatible with the old version. Valid values: true and false. Default… |
| Quality | string | no | Specifies whether to return the face quality result. This parameter is compatible with the old version. Valid values: true and false.… |
| MaxFaceNumber | integer | no | The maximum number of faces to return in the image. This parameter is compatible with the old version. Valid values: 1 to 10. Default… |

### Describes the syntax and examples of the RecognizePublicFace operation in the face and body category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/recognize-public-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| Task | string | no | 1 (JSON-encoded) |

### Describes the syntax and examples of the RetouchSkin operation in the facebody category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/retouch-skin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| ImageURL | string | yes | The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. If the file is stored on your on-premises… |
| RetouchDegree | number | no | The intensity of skin smoothing. Valid values: [0, 1.5]. Default value: 1.0. A larger value indicates less visible skin texture |
| WhiteningDegree | number | no | The intensity of skin whitening. Valid values: [0, 1.5]. Default value: 1.0. A larger value indicates whiter skin |

### Describes the syntax and examples for the SearchFace operation in the facebody category
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/search-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| DbName | string | no | The name of the database. Specify either DbName or DbNames. If both parameters are specified, DbNames takes precedence over DbName |
| ImageUrl | string | yes | The URL of the image. We recommend that you use an OSS URL in the China (Shanghai) region. For files stored on your local machine or in… |
| Limit | integer | yes | The maximum number of face search results to return for a single face. Valid values: 1 to 100 |
| DbNames | string | no | The list of database names, separated by commas (,). This parameter allows cross-database queries and supports up to 10 databases. Specify… |
| QualityScoreThreshold | number | no | The quality score threshold. The system analyzes the quality of the face image. If the obtained quality score is less than this threshold,… |
| MaxFaceNum | integer | no | The maximum number of faces in the input image to search and compare. This parameter controls the number of face sample lists. Valid… |

### Updates a face sample
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/update-face-entity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |
| DbName | string | yes | The name of the database |
| EntityId | string | yes | The entity ID, such as a user ID or employee ID |
| Labels | string | no | The custom labels. You can add up to 10 labels |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://facebody.cn-shanghai.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-facebody/add-face" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Viapi Facebody API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-facebody/add-face with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Viapi Facebody API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Viapi Facebody itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Viapi Facebody API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-facebody.

### What is the status of the Alibaba Cloud Viapi Facebody API?
Needs your own provider key (bring your own key)