{
  "opencollection": "1.0.0",
  "info": {
    "name": "Microsoft Azure AccessControlClient AccessConnector Facelists API",
    "version": "2020-08-01-preview"
  },
  "items": [
    {
      "info": {
        "name": "Facelists",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Microsoft Azure Get Facelists Facelistid",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/facelists/:faceListId",
            "params": [
              {
                "name": "faceListId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular face list."
              },
              {
                "name": "returnRecognitionModel",
                "value": "",
                "type": "query",
                "description": "A value indicating whether the operation should return 'recognitionModel' in response."
              }
            ]
          },
          "docs": "Retrieve a face list’s faceListId, name, userData, recognitionModel and faces in the face list.<br>"
        },
        {
          "info": {
            "name": "Microsoft Azure Put Facelists Facelistid",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/facelists/:faceListId",
            "params": [
              {
                "name": "faceListId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular face list."
              }
            ]
          },
          "docs": "Create an empty face list with user-specified faceListId, name, an optional userData and recognitionModel. Up to 64 face lists are allowed in one subscription.<br> Face list is a list of faces, up to 1,000 faces, and used by [Face - Find Similar](https://docs.microsoft.com/rest/api/faceapi/face/findsimilar).<br> After creation, user should use [FaceList - Add Face](https://docs.microsoft.com/rest/api/faceapi/facelist/addfacefromurl) to import the faces. No image will be stored. Only the extracte"
        },
        {
          "info": {
            "name": "Microsoft Azure Patch Facelists Facelistid",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/facelists/:faceListId",
            "params": [
              {
                "name": "faceListId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular face list."
              }
            ]
          },
          "docs": "Update information of a face list."
        },
        {
          "info": {
            "name": "Microsoft Azure Delete Facelists Facelistid",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/facelists/:faceListId",
            "params": [
              {
                "name": "faceListId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular face list."
              }
            ]
          },
          "docs": "Delete a specified face list."
        },
        {
          "info": {
            "name": "Microsoft Azure Get Facelists",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/facelists",
            "params": [
              {
                "name": "returnRecognitionModel",
                "value": "",
                "type": "query",
                "description": "A value indicating whether the operation should return 'recognitionModel' in response."
              }
            ]
          },
          "docs": "List face lists’ faceListId, name, userData and recognitionModel.  <br>To get face information inside faceList use [FaceList - Get](https://docs.microsoft.com/rest/api/faceapi/facelist/get)<br>"
        },
        {
          "info": {
            "name": "Microsoft Azure Delete Facelists Facelistid Persistedfaces Persistedfaceid",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/facelists/:faceListId/persistedfaces/:persistedFaceId",
            "params": [
              {
                "name": "faceListId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular face list."
              },
              {
                "name": "persistedFaceId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular persistedFaceId of an existing face."
              }
            ]
          },
          "docs": "Delete a face from a face list by specified faceListId and persistedFaceId.<br> Adding/deleting faces to/from a same face list are processed sequentially and to/from different face lists are in parallel."
        },
        {
          "info": {
            "name": "Microsoft Azure Post Facelists Facelistid Persistedfaces",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/facelists/:faceListId/persistedfaces",
            "params": [
              {
                "name": "faceListId",
                "value": "",
                "type": "path",
                "description": "Id referencing a particular face list."
              },
              {
                "name": "userData",
                "value": "",
                "type": "query",
                "description": "User-specified data about the face for any purpose. The maximum length is 1KB."
              },
              {
                "name": "targetFace",
                "value": "",
                "type": "query",
                "description": "A face rectangle to specify the target face to be added to a person in the format of \"targetFace=left,top,width,height\". E.g. \"targetFace=10,10,100,100\". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image."
              },
              {
                "name": "detectionModel",
                "value": "",
                "type": "query",
                "description": "Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it."
              }
            ]
          },
          "docs": "Add 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 targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature will be stored on server until [FaceList - Delete Face](https://docs.microsoft.com/rest/api/faceapi/facelist/deleteface) or [FaceList - Delete](https://docs.microsoft.com/rest/api/faceapi/facelist/delete) is c"
        }
      ]
    }
  ],
  "bundled": true
}