Azure Ai: Face
Azure Ai: Face endpoints from Microsoft Azure
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Azure Ai: Face endpoints from Microsoft Azure
Endpoints 63
- POSTDetect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.
/detect?detectionModel=detection_01&recognitionModel=recognition_01&returnFaceId=true&returnFaceAttributes=headPose&returnFaceLandmarks=false&returnRecognitionModel=false&faceIdTimeToLive=86400> [!IMPORTANT] > Microsoft has retired or limited facial recognition capabilities that can be used to try to infer emotional states and identity attributes… - POSTCreate a new detect liveness session.
/detectLiveness-sessionsA session is best for client device scenarios where developers want to authorize a client device to perform only a liveness detection without granting full… - GETLivenessSessionOperations_GetLivenessSessionResult
/detectLiveness-sessions/:sessionIdGet session result of detectLiveness/singleModal call. - DELETEDelete all session related information for matching the specified session id.
/detectLiveness-sessions/:sessionId> [!NOTE] > Deleting a session deactivates the Session Auth Token by blocking future API calls made with that Auth Token. While this can be used to remove any… - POSTCreate a new liveness session with verify. Provide the verify image during session creation.
/detectLivenessWithVerify-sessionsA session is best for client device scenarios where developers want to authorize a client device to perform only a liveness detection without granting full… - GETLivenessSessionOperations_GetLivenessWithVerifySessionResult
/detectLivenessWithVerify-sessions/:sessionIdGet session result of detectLivenessWithVerify/singleModal call. - DELETEDelete all session related information for matching the specified session id.
/detectLivenessWithVerify-sessions/:sessionId> [!NOTE] > Deleting a session deactivates the Session Auth Token by blocking future API calls made with that Auth Token. While this can be used to remove any… - GETFaceListOperations_GetFaceLists
/facelists?returnRecognitionModel=falseList Face Lists' faceListId, name, userData and recognitionModel. To get face information inside Face List use "Get Face List". - GETFaceListOperations_GetFaceList
/facelists/:faceListId?returnRecognitionModel=falseRetrieve a Face List's faceListId, name, userData, recognitionModel and faces in the Face List. - PUTCreate an empty Face List with user-specified faceListId, name, an optional userData and recognitionModel.
/facelists/:faceListIdUp to 64 Face Lists are allowed in one subscription. Face List is a list of faces, up to 1,000 faces, and used by "Find Similar From Face List". After… - DELETEFaceListOperations_DeleteFaceList
/facelists/:faceListIdDelete a specified Face List. - PATCHFaceListOperations_UpdateFaceList
/facelists/:faceListIdUpdate information of a Face List, including name and userData. - POSTAdd a face to a specified Face List, up to 1,000 faces.
/facelists/:faceListId/persistedfaces?targetFace=0&detectionModel=detection_01&userData=stringTo deal with an image containing multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId… - DELETEDelete a face from a Face List by specified faceListId and persistedFaceId.
/facelists/:faceListId/persistedfaces/:persistedFaceIdAdding/deleting faces to/from a same Face List are processed sequentially and to/from different Face Lists are in parallel. - POSTGiven query face's faceId, to search the similar-looking faces from a faceId array. A faceId array contains the faces created by Detect.
/findsimilarsDepending on the input the returned similar faces list contains faceIds or persistedFaceIds ranked by similarity. Find similar has two working modes,… - POSTDivide candidate faces into groups based on face similarity.
/group> * * The output is one or more disjointed face groups and a messyGroup. A face group contains faces that have similar looking, often of the same person. Face… - POST1-to-many identification to find the closest matches of the specific query person face from a Person Group.
/identifyFor each face in the faceIds array, Face Identify will compute similarities between the query face and all the faces in the Person Group (given by… - GETList Large Face Lists' information of largeFaceListId, name, userData and recognitionModel.
/largefacelists?start=string&top=1000&returnRecognitionModel=falseTo get face information inside largeFaceList use "Get Large Face List Face". Large Face Lists are stored in alphabetical order of largeFaceListId. > * *… - GETFaceListOperations_GetLargeFaceList
/largefacelists/:largeFaceListId?returnRecognitionModel=falseRetrieve a Large Face List's largeFaceListId, name, userData and recognitionModel. - PUTCreate an empty Large Face List with user-specified largeFaceListId, name, an optional userData and recognitionModel.
/largefacelists/:largeFaceListIdLarge Face List is a list of faces, up to 1,000,000 faces, and used by "Find Similar From Large Face List". After creation, user should use Add Large Face… - DELETEDelete a face from a Large Face List by specified largeFaceListId and persistedFaceId.
/largefacelists/:largeFaceListIdAdding/deleting faces to/from a same Large Face List are processed sequentially and to/from different Large Face Lists are in parallel. - PATCHFaceListOperations_UpdateLargeFaceList
/largefacelists/:largeFaceListIdUpdate information of a Large Face List, including name and userData. - GETList faces' persistedFaceId and userData in a specified Large Face List.
/largefacelists/:largeFaceListId/persistedfaces?start=string&top=1000Faces are stored in alphabetical order of persistedFaceId created in "Add Large Face List Face". > * * "start" parameter (string, optional) specifies an ID… - POSTAdd a face to a specified Large Face List, up to 1,000,000 faces.
/largefacelists/:largeFaceListId/persistedfaces?targetFace=0&detectionModel=detection_01&userData=stringTo deal with an image containing multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId… - GETFaceListOperations_GetLargeFaceListFace
/largefacelists/:largeFaceListId/persistedfaces/:persistedFaceIdRetrieve persisted face in Large Face List by largeFaceListId and persistedFaceId. - DELETEFaceListOperations_DeleteLargeFaceListFace
/largefacelists/:largeFaceListId/persistedfaces/:persistedFaceIdDelete a face from a Large Face List by specified largeFaceListId and persistedFaceId. - PATCHFaceListOperations_UpdateLargeFaceListFace
/largefacelists/:largeFaceListId/persistedfaces/:persistedFaceIdUpdate a specified face's userData field in a Large Face List by its persistedFaceId. - POSTSubmit a Large Face List training task.
/largefacelists/:largeFaceListId/trainTraining is a crucial step that only a trained Large Face List can be used by "Find Similar From Large Face List". The training task is an asynchronous task.… - GETFaceListOperations_GetLargeFaceListTrainingStatus
/largefacelists/:largeFaceListId/trainingTo check the Large Face List training status completed or still ongoing. Large Face List training is an asynchronous operation triggered by "Train Large Face… - GETList all existing Large Person Groups' largePersonGroupId, name, userData and recognitionModel.
/largepersongroups?start=string&top=1000&returnRecognitionModel=falseLarge Person Groups are stored in alphabetical order of largePersonGroupId. > * * "start" parameter (string, optional) specifies an ID value from which… - GETPersonGroupOperations_GetLargePersonGroup
/largepersongroups/:largePersonGroupId?returnRecognitionModel=falseRetrieve the information of a Large Person Group, including its name, userData and recognitionModel. This API returns Large Person Group information only, use… - PUTCreate a new Large Person Group with user-specified largePersonGroupId, name, an optional userData and recognitionModel.
/largepersongroups/:largePersonGroupIdA Large Person Group is a container holding the uploaded person data, including the face recognition features. It can hold up to 1,000,000 entities. After… - DELETEPersonGroupOperations_DeleteLargePersonGroup
/largepersongroups/:largePersonGroupIdDelete an existing Large Person Group with specified personGroupId. Persisted data in this Large Person Group will be deleted. - PATCHPersonGroupOperations_UpdateLargePersonGroup
/largepersongroups/:largePersonGroupIdUpdate an existing Large Person Group's name and userData. The properties keep unchanged if they are not in request body. - GETList all persons' information in the specified Large Person Group, including personId, name, userData and persistedFaceIds of registered person faces.
/largepersongroups/:largePersonGroupId/persons?start=string&top=1000Persons are stored in alphabetical order of personId created in "Create Large Person Group Person". > * * "start" parameter (string, optional) specifies an ID… - POSTCreate a new person in a specified Large Person Group. To add face to this person, please call "Add Large Person Group Person Face".
/largepersongroups/:largePersonGroupId/persons> [!NOTE] > > * > * Free-tier subscription quota: > * 1,000 persons in all Large Person Groups. > * S0-tier subscription quota: > * 1,000,000 persons per… - GETPersonGroupOperations_GetLargePersonGroupPerson
/largepersongroups/:largePersonGroupId/persons/:personIdRetrieve a person's name and userData, and the persisted faceIds representing the registered person face feature(s). - DELETEPersonGroupOperations_DeleteLargePersonGroupPerson
/largepersongroups/:largePersonGroupId/persons/:personIdDelete an existing person from a Large Person Group. The persistedFaceId, userData, person name and face feature(s) in the person entry will all be deleted. - PATCHPersonGroupOperations_UpdateLargePersonGroupPerson
/largepersongroups/:largePersonGroupId/persons/:personIdUpdate name or userData of a person. - POSTAdd a face to a person into a Large Person Group for face identification or verification.
/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces?targetFace=0&detectionModel=detection_01&userData=stringTo deal with an image containing multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId… - GETPersonGroupOperations_GetLargePersonGroupPersonFace
/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces/:persistedFaceIdRetrieve person face information. The persisted person face is specified by its largePersonGroupId, personId and persistedFaceId. - DELETEDelete a face from a person in a Large Person Group by specified largePersonGroupId, personId and persistedFaceId.
/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces/:persistedFaceIdAdding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel. - PATCHPersonGroupOperations_UpdateLargePersonGroupPersonFace
/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces/:persistedFaceIdUpdate a person persisted face's userData field. - POSTSubmit a Large Person Group training task. Training is a crucial step that only a trained Large Person Group can be used by "Identify From Large Person Group".
/largepersongroups/:largePersonGroupId/trainThe training task is an asynchronous task. Training time depends on the number of person entries, and their faces in a Large Person Group. It could be in… - GETTo check Large Person Group training status completed or still ongoing. Large Person Group training is an asynchronous operation triggered by "Train Large Person Group" API.
/largepersongroups/:largePersonGroupId/trainingTraining time depends on the number of person entries, and their faces in a Large Person Group. It could be in seconds, or up to half an hour for 1,000,000… - GETList Person Groups' personGroupId, name, userData and recognitionModel.
/persongroups?start=string&top=1000&returnRecognitionModel=falsePerson Groups are stored in alphabetical order of personGroupId. > * * "start" parameter (string, optional) specifies an ID value from which returned entries… - GETPersonGroupOperations_GetPersonGroup
/persongroups/:personGroupId?returnRecognitionModel=falseRetrieve Person Group name, userData and recognitionModel. To get person information under this personGroup, use "Get Person Group Persons". - PUTCreate a new Person Group with specified personGroupId, name, user-provided userData and recognitionModel.
/persongroups/:personGroupIdA Person Group is a container holding the uploaded person data, including face recognition features. After creation, use "Create Person Group Person" to add… - DELETEPersonGroupOperations_DeletePersonGroup
/persongroups/:personGroupIdDelete an existing Person Group with specified personGroupId. Persisted data in this Person Group will be deleted. - PATCHPersonGroupOperations_UpdatePersonGroup
/persongroups/:personGroupIdUpdate an existing Person Group's name and userData. The properties keep unchanged if they are not in request body. - GETList all persons' information in the specified Person Group, including personId, name, userData and persistedFaceIds of registered person faces.
/persongroups/:personGroupId/persons?start=string&top=1000Persons are stored in alphabetical order of personId created in "Create Person Group Person". > * * "start" parameter (string, optional) specifies an ID value… - POSTCreate a new person in a specified Person Group. To add face to this person, please call "Add Person Group Person Face".
/persongroups/:personGroupId/persons> [!NOTE] > > * > * Free-tier subscription quota: > * 1,000 persons in all Person Groups. > * S0-tier subscription quota: > * 10,000 persons per Person Group.… - GETPersonGroupOperations_GetPersonGroupPerson
/persongroups/:personGroupId/persons/:personIdRetrieve a person's name and userData, and the persisted faceIds representing the registered person face feature(s). - DELETEPersonGroupOperations_DeletePersonGroupPerson
/persongroups/:personGroupId/persons/:personIdDelete an existing person from a Person Group. The persistedFaceId, userData, person name and face feature(s) in the person entry will all be deleted. - PATCHPersonGroupOperations_UpdatePersonGroupPerson
/persongroups/:personGroupId/persons/:personIdUpdate name or userData of a person. - POSTAdd a face to a person into a Person Group for face identification or verification.
/persongroups/:personGroupId/persons/:personId/persistedfaces?targetFace=0&detectionModel=detection_01&userData=stringTo deal with an image containing multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId… - GETPersonGroupOperations_GetPersonGroupPersonFace
/persongroups/:personGroupId/persons/:personId/persistedfaces/:persistedFaceIdRetrieve person face information. The persisted person face is specified by its personGroupId, personId and persistedFaceId. - DELETEDelete a face from a person in a Person Group by specified personGroupId, personId and persistedFaceId.
/persongroups/:personGroupId/persons/:personId/persistedfaces/:persistedFaceIdAdding/deleting faces to/from a same person will be processed sequentially. Adding/deleting faces to/from different persons are processed in parallel. - PATCHPersonGroupOperations_UpdatePersonGroupPersonFace
/persongroups/:personGroupId/persons/:personId/persistedfaces/:persistedFaceIdUpdate a person persisted face's userData field. - POSTSubmit a Person Group training task. Training is a crucial step that only a trained Person Group can be used by "Identify From Person Group".
/persongroups/:personGroupId/trainThe training task is an asynchronous task. Training time depends on the number of person entries, and their faces in a Person Group. It could be several… - GETPersonGroupOperations_GetPersonGroupTrainingStatus
/persongroups/:personGroupId/trainingTo check Person Group training status completed or still ongoing. Person Group training is an asynchronous operation triggered by "Train Person Group" API. - GETLivenessSessionOperations_GetSessionImage
/sessionImages/:sessionImageIdGet session image stored during the liveness session. - POSTVerify whether two faces belong to a same person.
/verify> [!NOTE] > > * > * Higher face image quality means better identification precision. Please consider high-quality faces: frontal, clear, and face size is…
API details
- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the Ocp-Apim-Subscription-Key header - Operations
- 63 operations on 36 pathsGET 22POST 16DELETE 12PATCH 9PUT 4
- Response formats
application/json- Description format
- Swagger 2.0, API version
v1.2 - Links
- OpenAPI document
How to test the Azure Ai: Face in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Ai: Face collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.” (POST /detect?detectionModel=detection_01&recognitionModel=recognition_01&returnFaceId=true&returnFaceAttributes=headPose&returnFaceLandmarks=false&returnRecognitionModel=false&faceIdTimeToLive=86400), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure Ai: Face?
Azure Ai: Face endpoints from Microsoft Azure It is listed under AI & machine learning and has 63 endpoints.
Who publishes the Azure Ai: Face?
It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.
How do I authenticate with the Azure Ai: Face?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the Ocp-Apim-Subscription-Key header.
How many endpoints does the Azure Ai: Face have?
63 operations on 36 paths (22 GET, 16 POST, 12 DELETE, 9 PATCH, 4 PUT).
Is forking the Azure Ai: Face free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.