Face Index

Analyse, detect, extract, and index faces

Analyse, detect, extract, and index faces in an image. The method requires an asset_id in the path parameter to identify the image to analyze. The POST method also returns the asset ID of the image that was processed. 409 response indicates that an asset with the provided ID has been already processed.

This API will automatically update Asset metadata for built-in FileSpin field _filespin_fr_count with the count of faces indexed for the asset.

Note: A maximum of 10 faces will be detected and indexed per image

Request JSON

This example shows a request payload JSON to process an asset with ID asset_id and update the metadata.

{
    "disposition": {
        "update_metadata": true
    }
}