Download OpenAPI specification:Download
Detects all faces in an image and generates face templates
for each one. You can optionally limit the maximum number
of faces with the max-faces parameter. For
example you can set it to 1 to only allow
single-face images. The image can be in JPEG or PNG
formats.
| max-faces |
integer
Only allow this number of faces in an image. More will generate an error. |
| templates |
boolean
Default:
true
Flag to generate face templates or not. |
{
-
"faces":
[
-
{
-
"box":
{
-
"x":
0,
-
"y":
0,
-
"width":
0,
-
"height":
0
},
-
"template":
"string"
}
]
}
Matches two face templates and returns a probability of them belonging to the same person.
|
source
required
|
string
|
|
target
required
|
string
|
| calibration |
string
|
{
-
"source":
"string",
-
"target":
"string",
-
"calibration":
"string"
}
{
-
"probability": 0.1
}
Delete collection and all its records. By default only
deletes collections created by IDFace Match. You can
override this behavior with force parameter.
|
collection
required
|
string
Name of the collection. |
| force |
boolean
Default:
false
Remove any collection. |
{
-
"total_records": 0
}
Adds face templates as records into a collection. You can either provide an image or a list of face templates. For the first case all faces on an image will be detected and added to the collection. The image can be in JPEG or PNG formats.
|
collection
required
|
string
Name of the collection. |
| max-faces |
integer
Only allow this number of faces in an image. More will generate an error. |
{
-
"faces":
[
-
{
-
"box":
{
-
"x":
0,
-
"y":
0,
-
"width":
0,
-
"height":
0
},
-
"record_id":
"string"
}
]
}
Returns 200 if the record is present in the
collection. 404 otherwise.
|
collection
required
|
string
Name of the collection. |
|
id
required
|
string
ID of a face template record to delete. |
{
-
"error":
"string"
}
Creates face templates for all faces in an image and searches in the collection for similar faces. The image can be in JPEG or PNG formats.
|
collection
required
|
string
Name of the collection. |
| max-faces |
integer
Only allow this number of faces in an image. More will generate an error. |
| limit |
integer
Default:
5
Number of matched records to return for every face. |
| calibration |
string
Calibration for the probability. |
{
-
"faces":
[
-
{
-
"box":
{
-
"x":
0,
-
"y":
0,
-
"width":
0,
-
"height":
0
},
-
"matches":
[
-
{
-
"record_id":
"string",
-
"probability":
0.1
}
]
}
]
}