Recognize a face from an uploaded image

POST 
https://demo.frigate.video/api/faces/recognize

Recognizes a face from an uploaded image file by comparing it against registered faces in the system. Returns the recognized face name and confidence score, or an error if face recognition is not enabled or the image cannot be processed.

Request

multipart/form-data

Bodyrequired

filestring<binary>required

Responses

200

Successful Response

application/json

Schema

Schema

successSuccess (boolean)required

Whether the face recognition was successful

score object
Confidence score of the recognition (0-1)
anyOf
number
number
null
null
face_name object
The recognized face name if successful
anyOf
string
string
null
null

Example (auto)

{
  "success": true,
  "score": 0,
  "face_name": "string"
}

422

Validation Error

application/json

Schema

Schema

detail object[]
Array [
loc object[]required
Array [
anyOf
string
string
integer
integer
]
msgMessage (string)required
typeError Type (string)required
]

Example (auto)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

• python
• nodejs
• javascript
• curl
• rust

• HTTP.CLIENT
• REQUESTS

import http.client

conn = http.client.HTTPSConnection("demo.frigate.video")
payload = ''
headers = {
  'Content-Type': 'multipart/form-data',
  'Accept': 'application/json'
}
conn.request("POST", "/api/faces/recognize", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Request Collapse all

Base URL

https://demo.frigate.video/api

Body required

filerequired

file

ResponseClear

Click the Send API Request button above and see the response here!