POST
/
register
/
face

The Register Face endpoint allows you to register a face image that can be later used for detection and search operations. This is particularly useful when you want to associate metadata with specific faces for identification purposes.

Request

file
file
required

The image file containing the face to register

collection_id
string
required

The ID of the collection to associate the face with

metadata
object

Additional metadata to associate with the registered face

Response

task_id
string

The unique identifier for the asynchronous registration task

The response includes a task_id for the asynchronous face registration task. This task ID can be used to check the status of the registration process.

Checking Task Status

To check the status of the registration task, you can use the Task Status endpoint:

GET /tasks/<task_id>

Please refer to the Task Status page for more details on how to check the status of your task and retrieve the results.

Once the task is completed, the result will contain the details of the registered face, including the face_id, collection_id, and any associated metadata.

Now when you use the /understand/detect method (within /index), it will automatically find the registered face and return the associated metadata.

Additionally, when doing a search the face_id found will be returned in the search results, allowing you to retrieve the associated metadata.

Was this page helpful?