Face Recognition¶
APIs to build database¶
| End point | Description |
|---|---|
| POST /faces | Registers a new face and associates it with a person.image_file: The face imageperson_name: person's nameperson_id: person's IDeither person_name or person_id must be provided, not bothReturns face_id, person_id = both non null |
| PUT /persons/{person_id} | Updates a person's informationname: to rename a person (optiona)is_hidden: boolean to set or hide the personkey_face_id: face ID to be set as the key face |
| PUT /faces/{face_id} | Updates the person associated with this face. person_name: person's nameperson_id: person's ID either person_name or person_id must be provided, not both |
| DELETE /faces/{face_id} | Deletes the face from the database |
| DELETE /persons/{person_id} | Deletes the person and all the faces associated with. |
Query APIs¶
| GET /persons | Retrieves a list of all person records. For each person, it includes the face id list Response: List\<Person> |
| GET /persons/{person_id} | Retrieves a person's record along with all face ids associated with that person Response:Person |
| GET /faces/{face_id}/person | returns the ID of the person associated with that face Response:Person |
| GET /faces/{face_id} | download the face image Resonse: Image |
Detect Face¶
| GET /faces/scan | accept a single image and return information about every face detected within it |