# Azure AI Face API API

> Azure AI Face API API on Apizie: 63 endpoints (Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and…, Create a new detect liveness session., Get session result of detectLiveness/singleModal call., Delete all session related information for matching the specified session id., …) 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:azure-ai-face/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:azure-ai-face`
- Category: Cloud
- Status: byok
- Source: https://learn.microsoft.com/rest/api/azure/
- Page: https://zieapi.vercel.app/api/cloud/azure-ai-face
- OpenAPI: https://zieapi.vercel.app/api/cloud/azure-ai-face/openapi.json



## Endpoints

### Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and…
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-detection-operations-detect-from-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| detectionModel | string | no | The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and… |
| recognitionModel | string | no | The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel' values include 'recognition_01',… |
| returnFaceId | boolean | no | Return faceIds of the detected faces or not. The default value is true. |
| returnFaceAttributes | array | no | Analyze and return the one or more specified face attributes in the comma-separated string like 'returnFaceAttributes=headPose,glasses'.… |
| returnFaceLandmarks | boolean | no | Return face landmarks of the detected faces or not. The default value is false. |
| returnRecognitionModel | boolean | no | Return 'recognitionModel' or not. The default value is false. This is only applicable when returnFaceId = true. |
| faceIdTimeToLive | integer | no | The number of seconds for the face ID being cached. Supported range from 60 seconds up to 86400 seconds. The default value is 86400 (24… |
| body | object | yes | JSON request body |

### Create a new detect liveness session.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/liveness-session-operations-create-liveness-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| body | object | yes | JSON request body |

### Get session result of detectLiveness/singleModal call.
`GET https://zieapi.vercel.app/v1/cloud:azure-ai-face/liveness-session-operations-get-liveness-session-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| sessionId | string | yes | The unique ID to reference this session. |

### Delete all session related information for matching the specified session id.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/liveness-session-operations-delete-liveness-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| sessionId | string | yes | The unique ID to reference this session. |

### Create a new liveness session with verify. Provide the verify image during session creation.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/liveness-session-operations-create-liveness-with-verify-sess` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| body | object | no | Form fields as a JSON object |

### Get session result of detectLivenessWithVerify/singleModal call.
`GET https://zieapi.vercel.app/v1/cloud:azure-ai-face/liveness-session-operations-get-liveness-with-verify-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| sessionId | string | yes | The unique ID to reference this session. |

### Delete all session related information for matching the specified session id.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/liveness-session-operations-delete-liveness-with-verify-sess` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| sessionId | string | yes | The unique ID to reference this session. |

### List Face Lists' faceListId, name, userData and recognitionModel. To get face information inside Face List…
`GET https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-list-operations-get-face-lists` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| returnRecognitionModel | boolean | no | Return 'recognitionModel' or not. The default value is false. |

### Retrieve a Face List's faceListId, name, userData, recognitionModel and faces in the Face List.
`GET https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-list-operations-get-face-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| faceListId | string | yes | Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. |
| returnRecognitionModel | boolean | no | Return 'recognitionModel' or not. The default value is false. |

### Create an empty Face List with user-specified faceListId, name, an optional userData and recognitionModel.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-list-operations-create-face-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| faceListId | string | yes | Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. |
| body | object | yes | JSON request body |

### Update information of a Face List, including name and userData.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-list-operations-update-face-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| faceListId | string | yes | Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. |
| body | object | yes | JSON request body |

### Delete a specified Face List.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-list-operations-delete-face-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| faceListId | string | yes | Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. |

### Add a face to a specified Face List, up to 1,000 faces.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-list-operations-add-face-list-face-from-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| faceListId | string | yes | Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. |
| targetFace | array | no | A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. |
| detectionModel | string | no | The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and… |
| userData | string | no | User-provided data attached to the face. The size limit is 1K. |
| body | object | yes | JSON request body |

### Delete a face from a Face List by specified faceListId and persistedFaceId.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-list-operations-delete-face-list-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| faceListId | string | yes | Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. |
| persistedFaceId | string | yes | Face ID of the face. |

### Given query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains…
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-recognition-operations-find-similar` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| body | object | yes | JSON request body |

### Divide candidate faces into groups based on face similarity.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-recognition-operations-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| body | object | yes | JSON request body |

### 1-to-many identification to find the closest matches of the specific query person face from a Person Group.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-recognition-operations-identify-from-person-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| body | object | yes | JSON request body |

### List Large Face Lists' information of largeFaceListId, name, userData and recognitionModel.
`GET https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-list-operations-get-large-face-lists` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| start | string | no | List resources greater than the "start". It contains no more than 64 characters. Default is empty. |
| top | integer | no | The number of items to list, ranging in [1, 1000]. Default is 1000. |
| returnRecognitionModel | boolean | no | Return 'recognitionModel' or not. The default value is false. |

### Retrieve a Large Face List's largeFaceListId, name, userData and recognitionModel.
`GET https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-list-operations-get-large-face-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largeFaceListId | string | yes | Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. |
| returnRecognitionModel | boolean | no | Return 'recognitionModel' or not. The default value is false. |

### Create an empty Large Face List with user-specified largeFaceListId, name, an optional userData and…
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-list-operations-create-large-face-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largeFaceListId | string | yes | Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. |
| body | object | yes | JSON request body |

### Update information of a Large Face List, including name and userData.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-list-operations-update-large-face-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largeFaceListId | string | yes | Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. |
| body | object | yes | JSON request body |

### Delete a face from a Large Face List by specified largeFaceListId and persistedFaceId.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-list-operations-delete-large-face-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largeFaceListId | string | yes | Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. |

### List faces' persistedFaceId and userData in a specified Large Face List.
`GET https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-list-operations-get-large-face-list-faces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largeFaceListId | string | yes | Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. |
| start | string | no | List resources greater than the "start". It contains no more than 64 characters. Default is empty. |
| top | integer | no | The number of items to list, ranging in [1, 1000]. Default is 1000. |

### Add a face to a specified Large Face List, up to 1,000,000 faces.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-list-operations-add-large-face-list-face-from-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largeFaceListId | string | yes | Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. |
| targetFace | array | no | A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. |
| detectionModel | string | no | The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and… |
| userData | string | no | User-provided data attached to the face. The size limit is 1K. |
| body | object | yes | JSON request body |

### Retrieve persisted face in Large Face List by largeFaceListId and persistedFaceId.
`GET https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-list-operations-get-large-face-list-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largeFaceListId | string | yes | Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. |
| persistedFaceId | string | yes | Face ID of the face. |

### Update a specified face's userData field in a Large Face List by its persistedFaceId.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-list-operations-update-large-face-list-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largeFaceListId | string | yes | Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. |
| persistedFaceId | string | yes | Face ID of the face. |
| body | object | yes | JSON request body |

### Delete a face from a Large Face List by specified largeFaceListId and persistedFaceId.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-list-operations-delete-large-face-list-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largeFaceListId | string | yes | Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. |
| persistedFaceId | string | yes | Face ID of the face. |

### Submit a Large Face List training task.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-list-operations-train-large-face-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largeFaceListId | string | yes | Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. |

### To check the Large Face List training status completed or still ongoing. Large Face List training is an…
`GET https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-list-operations-get-large-face-list-training-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largeFaceListId | string | yes | Valid character is letter in lower case or digit or '-' or '_', maximum length is 64. |

### List all existing Large Person Groups' largePersonGroupId, name, userData and recognitionModel.
`GET https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-get-large-person-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| start | string | no | List resources greater than the "start". It contains no more than 64 characters. Default is empty. |
| top | integer | no | The number of items to list, ranging in [1, 1000]. Default is 1000. |
| returnRecognitionModel | boolean | no | Return 'recognitionModel' or not. The default value is false. |

### Retrieve the information of a Large Person Group, including its name, userData and recognitionModel. This…
`GET https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-get-large-person-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largePersonGroupId | string | yes | ID of the container. |
| returnRecognitionModel | boolean | no | Return 'recognitionModel' or not. The default value is false. |

### Create a new Large Person Group with user-specified largePersonGroupId, name, an optional userData and…
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-create-large-person-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largePersonGroupId | string | yes | ID of the container. |
| body | object | yes | JSON request body |

### Update an existing Large Person Group's name and userData. The properties keep unchanged if they are not in…
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-update-large-person-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largePersonGroupId | string | yes | ID of the container. |
| body | object | yes | JSON request body |

### Delete an existing Large Person Group with specified personGroupId. Persisted data in this Large Person…
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-delete-large-person-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largePersonGroupId | string | yes | ID of the container. |

### List all persons' information in the specified Large Person Group, including personId, name, userData and…
`GET https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-get-large-person-group-persons` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largePersonGroupId | string | yes | ID of the container. |
| start | string | no | List resources greater than the "start". It contains no more than 64 characters. Default is empty. |
| top | integer | no | The number of items to list, ranging in [1, 1000]. Default is 1000. |

### Create a new person in a specified Large Person Group. To add face to this person, please call "Add Large…
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-create-large-person-group-person` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largePersonGroupId | string | yes | ID of the container. |
| body | object | yes | JSON request body |

### Retrieve a person's name and userData, and the persisted faceIds representing the registered person face…
`GET https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-get-large-person-group-person` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largePersonGroupId | string | yes | ID of the container. |
| personId | string | yes | ID of the person. |

### Update name or userData of a person.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-update-large-person-group-person` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largePersonGroupId | string | yes | ID of the container. |
| personId | string | yes | ID of the person. |
| body | object | yes | JSON request body |

### Delete an existing person from a Large Person Group. The persistedFaceId, userData, person name and face…
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-delete-large-person-group-person` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largePersonGroupId | string | yes | ID of the container. |
| personId | string | yes | ID of the person. |

### Add a face to a person into a Large Person Group for face identification or verification.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-add-large-person-group-person-face-f` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largePersonGroupId | string | yes | ID of the container. |
| personId | string | yes | ID of the person. |
| targetFace | array | no | A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. |
| detectionModel | string | no | The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and… |
| userData | string | no | User-provided data attached to the face. The size limit is 1K. |
| body | object | yes | JSON request body |

### Retrieve person face information. The persisted person face is specified by its largePersonGroupId, personId…
`GET https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-get-large-person-group-person-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largePersonGroupId | string | yes | ID of the container. |
| personId | string | yes | ID of the person. |
| persistedFaceId | string | yes | Face ID of the face. |

### Update a person persisted face's userData field.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-update-large-person-group-person-fac` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largePersonGroupId | string | yes | ID of the container. |
| personId | string | yes | ID of the person. |
| persistedFaceId | string | yes | Face ID of the face. |
| body | object | yes | JSON request body |

### Delete a face from a person in a Large Person Group by specified largePersonGroupId, personId and…
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-delete-large-person-group-person-fac` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largePersonGroupId | string | yes | ID of the container. |
| personId | string | yes | ID of the person. |
| persistedFaceId | string | yes | Face ID of the face. |

### Submit a Large Person Group training task. Training is a crucial step that only a trained Large Person Group…
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-train-large-person-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largePersonGroupId | string | yes | ID of the container. |

### To check Large Person Group training status completed or still ongoing. Large Person Group training is an…
`GET https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-get-large-person-group-training-stat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| largePersonGroupId | string | yes | ID of the container. |

### List Person Groups' personGroupId, name, userData and recognitionModel.
`GET https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-get-person-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| start | string | no | List resources greater than the "start". It contains no more than 64 characters. Default is empty. |
| top | integer | no | The number of items to list, ranging in [1, 1000]. Default is 1000. |
| returnRecognitionModel | boolean | no | Return 'recognitionModel' or not. The default value is false. |

### Retrieve Person Group name, userData and recognitionModel. To get person information under this personGroup,…
`GET https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-get-person-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| personGroupId | string | yes | ID of the container. |
| returnRecognitionModel | boolean | no | Return 'recognitionModel' or not. The default value is false. |

### Create a new Person Group with specified personGroupId, name, user-provided userData and recognitionModel.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-create-person-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| personGroupId | string | yes | ID of the container. |
| body | object | yes | JSON request body |

### Update an existing Person Group's name and userData. The properties keep unchanged if they are not in…
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-update-person-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| personGroupId | string | yes | ID of the container. |
| body | object | yes | JSON request body |

### Delete an existing Person Group with specified personGroupId. Persisted data in this Person Group will be…
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-delete-person-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| personGroupId | string | yes | ID of the container. |

### List all persons' information in the specified Person Group, including personId, name, userData and…
`GET https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-get-person-group-persons` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| personGroupId | string | yes | ID of the container. |
| start | string | no | List resources greater than the "start". It contains no more than 64 characters. Default is empty. |
| top | integer | no | The number of items to list, ranging in [1, 1000]. Default is 1000. |

### Create a new person in a specified Person Group. To add face to this person, please call "Add Person Group…
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-create-person-group-person` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| personGroupId | string | yes | ID of the container. |
| body | object | yes | JSON request body |

### Retrieve a person's name and userData, and the persisted faceIds representing the registered person face…
`GET https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-get-person-group-person` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| personGroupId | string | yes | ID of the container. |
| personId | string | yes | ID of the person. |

### Update name or userData of a person.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-update-person-group-person` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| personGroupId | string | yes | ID of the container. |
| personId | string | yes | ID of the person. |
| body | object | yes | JSON request body |

### Delete an existing person from a Person Group. The persistedFaceId, userData, person name and face…
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-delete-person-group-person` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| personGroupId | string | yes | ID of the container. |
| personId | string | yes | ID of the person. |

### Add a face to a person into a Person Group for face identification or verification.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-add-person-group-person-face-from-ur` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| personGroupId | string | yes | ID of the container. |
| personId | string | yes | ID of the person. |
| targetFace | array | no | A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. |
| detectionModel | string | no | The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and… |
| userData | string | no | User-provided data attached to the face. The size limit is 1K. |
| body | object | yes | JSON request body |

### Retrieve person face information. The persisted person face is specified by its personGroupId, personId and…
`GET https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-get-person-group-person-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| personGroupId | string | yes | ID of the container. |
| personId | string | yes | ID of the person. |
| persistedFaceId | string | yes | Face ID of the face. |

### Update a person persisted face's userData field.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-update-person-group-person-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| personGroupId | string | yes | ID of the container. |
| personId | string | yes | ID of the person. |
| persistedFaceId | string | yes | Face ID of the face. |
| body | object | yes | JSON request body |

### Delete a face from a person in a Person Group by specified personGroupId, personId and persistedFaceId.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-delete-person-group-person-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| personGroupId | string | yes | ID of the container. |
| personId | string | yes | ID of the person. |
| persistedFaceId | string | yes | Face ID of the face. |

### Submit a Person Group training task. Training is a crucial step that only a trained Person Group can be used…
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-train-person-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| personGroupId | string | yes | ID of the container. |

### To check Person Group training status completed or still ongoing. Person Group training is an asynchronous…
`GET https://zieapi.vercel.app/v1/cloud:azure-ai-face/person-group-operations-get-person-group-training-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| personGroupId | string | yes | ID of the container. |

### Get session image stored during the liveness session.
`GET https://zieapi.vercel.app/v1/cloud:azure-ai-face/liveness-session-operations-get-session-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| sessionImageId | string | yes | The request ID of the image to be retrieved |

### Verify whether two faces belong to a same person.
`POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-recognition-operations-verify-face-to-face` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com). |
| apiVersion | string | yes | API Version |
| body | object | yes | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-detection-operations-detect-from-url" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Azure AI Face API API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:azure-ai-face/face-detection-operations-detect-from-url with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Azure AI Face API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Azure AI Face API itself also needs your own key from azure.com.

### Can AI agents use the Azure AI Face API 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:azure-ai-face.

### What is the status of the Azure AI Face API API?
Needs your own provider key (bring your own key)