Register a face image

POST 
https://demo.frigate.video/api/faces/:name/register

Registers a face image for a specific face name by uploading an image file. The uploaded image is processed and added to the face recognition system. Returns a success response with details about the registration, or an error if face recognition is not enabled or the image cannot be processed.

Request

Path Parameters

name Namerequired

multipart/form-data

Bodyrequired

filestring<binary>required

Responses

200

Successful Response

application/json

Schema

Schema

successSuccess (boolean)required
messageMessage (string)required

Example (auto)

{
  "success": true,
  "message": "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/:name/register", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Request Collapse all

Base URL

https://demo.frigate.video/api

Parameters

name — pathrequired

Body required

filerequired

file

ResponseClear

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