Face Recognition

This API will be deprecated in June 1st 2021. Please consider to use Sync V2
Send a POST request to https://api.cloud.nodeflux.io/v1beta1/image-analytic/stream by providing these arguments as application/json.
Headers
Key
Value
Content-type
application/json
Authorization
Your authorization key.
x-nodeflux-timestamp
x-nodeflux-timestamp from the Authorization API.
Request Body
1
{
2
  "analytics": [
3
    {
4
      "type": "FACE_RECOGNITION",
5
      "options": {
6
        "@type": "type.googleapis.com/nodeflux.analytics.v1beta1.FaceRecognitionOptions",
7
        "candidateCount": 2
8
        }
9
    }
10
  ],
11
  "image": {
12
    "encoding": "IMAGE_ENCODING_JPEG",
13
    "content": "{INSERT_JPEG_IMAGE_AS_BASE64_STRING}"
14
  }
15
}
Copied!
Response Body
HTTP Mapping: 200 OK
1
{
2
  "result": {
3
    "face_recognitions": [
4
      {
5
        "candidates": [
6
          {
7
            "face_id":"30604573299179521",
8
            "confidence": 1,
9
            "auto_enrolled": false,
10
            "similarity": 1,
11
            "variation":"17952130604573299"
12
          },
13
          {
14
            "face_id":"30604573299175432",
15
            "confidence": 0.81,
16
            "auto_enrolled": false,
17
            "similarity": 0.81,
18
            "variation":"17952130604573292"
19
          }
20
        ]
21
      }
22
    ]
23
  }
24
}
Copied!
!!! warning "Confidence Field"
1
Confidence field deprecated, use field `similarity` instead.
Copied!
!!! warning "Variation Value"
1
`variation` value is `variation` associated with enrolled face, not `variation` associated with requested face to recognize.
Copied!
!!! warning "Candidate Value"
1
Maximum number of `candidateCount` value is `5`.
Copied!
!!! info "Protocol Reference"
1
Protocol reference available on [nodeflux.analytics.v1beta1.FaceRecognition](../../protocol/analytics#nodeflux.analytics.v1beta1.FaceRecognition)
Copied!

Face Enrollment

Face Match with 2 Photos

Last modified 9mo ago

Copy link

Contents

Headers

Request Body

Response Body