Azure AI Services: Face
An API for face detection, verification, and identification.
AI & machine learning#openapi#cloud
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
An API for face detection, verification, and identification.
Endpoints 63
- POSTFace_FindSimilar
/findsimilarsGiven query face's faceId, to search the similar-looking faces from a faceId array, a face list or a large face list. faceId array contains the faces created… - POSTFace_Group
/groupDivide candidate faces into groups based on face similarity.<br /> * The output is one or more disjointed face groups and a messyGroup. A face group contains… - POSTFace_Identify
/identify1-to-many identification to find the closest matches of the specific query person face from a person group or large person group. <br/> For each face in the… - POSTFace_VerifyFaceToFace
/verifyVerify whether two faces belong to a same person or whether one face belongs to a person. <br/> Remarks:<br /> * Higher face image quality means better… - GETPersonGroupPerson_List
/persongroups/:personGroupId/persons?start=string&top=1List all persons in a person group, and retrieve person information (including personId, name, userData and persistedFaceIds of registered faces of the person). - POSTPersonGroupPerson_Create
/persongroups/:personGroupId/personsCreate a new person in a specified person group. - GETPersonGroupPerson_Get
/persongroups/:personGroupId/persons/:personIdRetrieve a person's information, including registered persisted faces, name and userData. - DELETEPersonGroupPerson_Delete
/persongroups/:personGroupId/persons/:personIdDelete an existing person from a person group. The persistedFaceId, userData, person name and face feature in the person entry will all be deleted. - PATCHPersonGroupPerson_Update
/persongroups/:personGroupId/persons/:personIdUpdate name or userData of a person. - GETPersonGroupPerson_GetFace
/persongroups/:personGroupId/persons/:personId/persistedfaces/:persistedFaceIdRetrieve information about a persisted face (specified by persistedFaceId, personId and its belonging personGroupId). - DELETEPersonGroupPerson_DeleteFace
/persongroups/:personGroupId/persons/:personId/persistedfaces/:persistedFaceIdDelete a face from a person in a person group by specified personGroupId, personId and persistedFaceId. <br /> Adding/deleting faces to/from a same person… - PATCHPersonGroupPerson_UpdateFace
/persongroups/:personGroupId/persons/:personId/persistedfaces/:persistedFaceIdAdd a face to a person into a person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified… - GETPersonGroup_Get
/persongroups/:personGroupId?returnRecognitionModel=falseRetrieve person group name, userData and recognitionModel. To get person information under this personGroup, use PersonGroup Person - List. - PUTPersonGroup_Create
/persongroups/:personGroupIdCreate a new person group with specified personGroupId, name, user-provided userData and recognitionModel. <br /> A person group is the container of the… - DELETEPersonGroup_Delete
/persongroups/:personGroupIdDelete an existing person group. Persisted face features of all people in the person group will also be deleted. - PATCHPersonGroup_Update
/persongroups/:personGroupIdUpdate an existing person group's display name and userData. The properties which does not appear in request body will not be updated. - GETPersonGroup_GetTrainingStatus
/persongroups/:personGroupId/trainingRetrieve the training status of a person group (completed or ongoing). - GETPersonGroup_List
/persongroups?start=string&top=1000&returnRecognitionModel=falseList person groups’ personGroupId, name, userData and recognitionModel.<br /> * Person groups are stored in alphabetical order of personGroupId. * "start"… - POSTPersonGroup_Train
/persongroups/:personGroupId/trainQueue a person group training task, the training task may not be started immediately. - GETFaceList_Get
/facelists/:faceListId?returnRecognitionModel=falseRetrieve a face list’s faceListId, name, userData, recognitionModel and faces in the face list. - PUTFaceList_Create
/facelists/:faceListIdCreate an empty face list with user-specified faceListId, name, an optional userData and recognitionModel. Up to 64 face lists are allowed in one… - DELETEFaceList_Delete
/facelists/:faceListIdDelete a specified face list. - PATCHFaceList_Update
/facelists/:faceListIdUpdate information of a face list. - GETFaceList_List
/facelists?returnRecognitionModel=falseList face lists’ faceListId, name, userData and recognitionModel. <br /> To get face information inside faceList use FaceList - Get - DELETEFaceList_DeleteFace
/facelists/:faceListId/persistedfaces/:persistedFaceIdDelete a face from a face list by specified faceListId and persistedFaceId. <br /> Adding/deleting faces to/from a same face list are processed sequentially… - POSTPersonGroupPerson_AddFaceFromUrl
/persongroups/:personGroupId/persons/:personId/persistedfaces?userData=string&targetFace=0&detectionModel=detection_01Add a face to a person into a person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified… - POSTFace_DetectWithUrl
/detect?returnFaceId=true&returnFaceLandmarks=false&returnFaceAttributes=age&recognitionModel=recognition_01&returnRecognitionModel=false&detectionModel=detection_01&faceIdTimeToLive=86400Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.<br /> * No image will be stored. Only the… - POSTFaceList_AddFaceFromUrl
/facelists/:faceListId/persistedfaces?userData=string&targetFace=0&detectionModel=detection_01Add a face to a specified face list, up to 1,000 faces. <br /> To deal with an image contains multiple faces, input face can be specified as an image with a… - GETLargePersonGroupPerson_List
/largepersongroups/:largePersonGroupId/persons?start=string&top=1List all persons in a large person group, and retrieve person information (including personId, name, userData and persistedFaceIds of registered faces of the… - POSTLargePersonGroupPerson_Create
/largepersongroups/:largePersonGroupId/personsCreate a new person in a specified large person group. - GETLargePersonGroupPerson_Get
/largepersongroups/:largePersonGroupId/persons/:personIdRetrieve a person's name and userData, and the persisted faceIds representing the registered person face feature. - DELETELargePersonGroupPerson_Delete
/largepersongroups/:largePersonGroupId/persons/:personIdDelete an existing person from a large person group. The persistedFaceId, userData, person name and face feature in the person entry will all be deleted. - PATCHLargePersonGroupPerson_Update
/largepersongroups/:largePersonGroupId/persons/:personIdUpdate name or userData of a person. - GETLargePersonGroupPerson_GetFace
/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces/:persistedFaceIdRetrieve information about a persisted face (specified by persistedFaceId, personId and its belonging largePersonGroupId). - DELETELargePersonGroupPerson_DeleteFace
/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces/:persistedFaceIdDelete a face from a person in a large person group by specified largePersonGroupId, personId and persistedFaceId. <br /> Adding/deleting faces to/from a same… - PATCHLargePersonGroupPerson_UpdateFace
/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces/:persistedFaceIdUpdate a person persisted face's userData field. - GETLargePersonGroup_Get
/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… - PUTLargePersonGroup_Create
/largepersongroups/:largePersonGroupIdCreate a new large person group with user-specified largePersonGroupId, name, an optional userData and recognitionModel. <br /> A large person group is the… - DELETELargePersonGroup_Delete
/largepersongroups/:largePersonGroupIdDelete an existing large person group. Persisted face features of all people in the large person group will also be deleted. - PATCHLargePersonGroup_Update
/largepersongroups/:largePersonGroupIdUpdate an existing large person group's display name and userData. The properties which does not appear in request body will not be updated. - GETLargePersonGroup_GetTrainingStatus
/largepersongroups/:largePersonGroupId/trainingRetrieve the training status of a large person group (completed or ongoing). - GETLargePersonGroup_List
/largepersongroups?start=string&top=1000&returnRecognitionModel=falseList all existing large person groups’ largePersonGroupId, name, userData and recognitionModel.<br /> * Large person groups are stored in alphabetical order… - POSTLargePersonGroup_Train
/largepersongroups/:largePersonGroupId/trainQueue a large person group training task, the training task may not be started immediately. - POSTLargePersonGroupPerson_AddFaceFromUrl
/largepersongroups/:largePersonGroupId/persons/:personId/persistedfaces?userData=string&targetFace=0&detectionModel=detection_01Add a face to a person into a large person group for face identification or verification. To deal with an image contains multiple faces, input face can be… - GETLargeFaceList_Get
/largefacelists/:largeFaceListId?returnRecognitionModel=falseRetrieve a large face list’s largeFaceListId, name, userData and recognitionModel. - PUTLargeFaceList_Create
/largefacelists/:largeFaceListIdCreate an empty large face list with user-specified largeFaceListId, name, an optional userData and recognitionModel. <br /> Large face list is a list of… - DELETELargeFaceList_Delete
/largefacelists/:largeFaceListIdDelete a specified large face list. - PATCHLargeFaceList_Update
/largefacelists/:largeFaceListIdUpdate information of a large face list. - GETLargeFaceList_GetTrainingStatus
/largefacelists/:largeFaceListId/trainingRetrieve the training status of a large face list (completed or ongoing). - GETLargeFaceList_List
/largefacelists?returnRecognitionModel=false&start=string&top=1List large face lists’ information of largeFaceListId, name, userData and recognitionModel. <br /> To get face information inside largeFaceList use… - POSTLargeFaceList_Train
/largefacelists/:largeFaceListId/trainQueue a large face list training task, the training task may not be started immediately. - GETLargeFaceList_GetFace
/largefacelists/:largeFaceListId/persistedfaces/:persistedFaceIdRetrieve information about a persisted face (specified by persistedFaceId and its belonging largeFaceListId). - DELETELargeFaceList_DeleteFace
/largefacelists/:largeFaceListId/persistedfaces/:persistedFaceIdDelete a face from a large face list by specified largeFaceListId and persistedFaceId. <br /> Adding/deleting faces to/from a same large face list are… - PATCHLargeFaceList_UpdateFace
/largefacelists/:largeFaceListId/persistedfaces/:persistedFaceIdUpdate a persisted face's userData field. - GETLargeFaceList_ListFaces
/largefacelists/:largeFaceListId/persistedfaces?start=string&top=1List all faces in a large face list, and retrieve face information (including userData and persistedFaceIds of registered faces of the face). - POSTLargeFaceList_AddFaceFromUrl
/largefacelists/:largeFaceListId/persistedfaces?userData=string&targetFace=0&detectionModel=detection_01Add a face to a specified large face list, up to 1,000,000 faces. <br /> To deal with an image contains multiple faces, input face can be specified as an… - GETSnapshot_List
/snapshots?type=FaceList&applyScope=3fa85f64-5717-4562-b3fc-2c963f66afa6List all accessible snapshots with related information, including snapshots that were taken by the user, or snapshots to be applied to the user (subscription… - POSTSnapshot_Take
/snapshotsSubmit an operation to take a snapshot of face list, large face list, person group or large person group, with user-specified snapshot type, source object id,… - GETSnapshot_Get
/snapshots/:snapshotIdRetrieve information about a snapshot. Snapshot is only accessible to the source subscription who took it, and target subscriptions included in the applyScope… - DELETESnapshot_Delete
/snapshots/:snapshotIdDelete an existing snapshot according to the snapshotId. All object data and information in the snapshot will also be deleted. Only the source subscription… - PATCHSnapshot_Update
/snapshots/:snapshotIdUpdate the information of a snapshot. Only the source subscription who took the snapshot can update the snapshot. - POSTSnapshot_Apply
/snapshots/:snapshotId/applySubmit an operation to apply a snapshot to current subscription. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply… - GETSnapshot_GetOperationStatus
/operations/:operationIdRetrieve the status of a take/apply snapshot operation.
API details
- Authentication
- An API key in the Ocp-Apim-Subscription-Key header
- Operations
- 63 operations on 35 pathsGET 22POST 16DELETE 11PATCH 10PUT 4
- Description format
- Swagger 2.0, API version
1.0 - Links
- OpenAPI document
How to test the Azure AI Services: 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 Services: Face collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Ocp-Apim-Subscription-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Face_FindSimilar” (POST /findsimilars), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure AI Services: Face?
An API for face detection, verification, and identification. It is listed under AI & machine learning and has 63 endpoints.
Who publishes the Azure AI Services: 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 Services: Face?
With an API key in the Ocp-Apim-Subscription-Key header.
How many endpoints does the Azure AI Services: Face have?
63 operations on 35 paths (22 GET, 16 POST, 11 DELETE, 10 PATCH, 4 PUT).
Is forking the Azure AI Services: Face free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.