Tags/get method allows to get already saved tags to data namespace. By specifying different parameters and criteria you can influence the returned tags.
Method entry point:
https://api.skybiometry.com/fc/tags/get
- Supported HTTP methods
- GET, POST.
- Required parameters
-
- standard API parameters
- uids – a comma separated list of user ids to get tags for.
- pids – a comma separated list of photo ids to get tags for (photo ids are returned for faces/detect and faces/recognize).
- urls – a comma separated list of images to get tags for (accepted image formats: PNG, JPEG, BMP, JPEG2000).
- Optional parameters
-
- limit – maximum tags to return (default: 5).
- together – when multiple uids are provided, return only tags for photos where all uids appear together in the photo(s) (default: false).
- order – specifies the order of returned tags (recent – for latest tags, random – random selected tags) (default: “recent”).
- namespace – default data namespace to be used for all specified uids without data namespace specified.
- filter – ability to specify facial attributes for filtering the returned tags.
Note: at least one of the required parameters should be specified. You can also upload an image instead of specifying image urls.
Note: in case where you want to POST images instead of specifying urls, request to the method must be formed as a MIME multi-part message sent using POST data. Each argument should be specified as a separate chunk of form data.
example:
https://api.skybiometry.com/fc/tags/get.json?api_key=aa754b54b37&api_secret=4b3a4c6d4c&uids=mary@docs
response:
{
"photos" : [
{
"url" : "https://tinyurl.com/673cksa",
"pid" : "F@053a763a06d9d578430b9f2d06c686bb_f0bf798c4c4e8",
"width" : 1024,
"height" : 767,
"tags" : [
{
"tid" : "c24ac564_f0bf798c4c4e8",
"recognizable" : true,
"uids" : [
{
"uid" : "mary@docs",
"confidence" : 100
}
],
"threshold" : 50,
"label" : "",
"confirmed" : true,
"manual" : false,
"width" :27.73,
"height" : 37.03,
"center" : { "x" : 64.75, "y" : 48.24 },
"eye_left" : { "x" : 66.5, "y" : 39.24 },
"eye_right" : { "x" : 53.12, "y" : 34.55 },
"yaw" : 45,
"roll" : 15,
"pitch" : 0,
"attributes" : {
"face" : { "value" : "true", "confidence" : 71 }
}
}
]
}
],
"status" : "success",
"usage" : {
"used" : 1,
"remaining" : 99,
"limit" : 100,
"reset_time_text" : "Fri, 22 September 2012 12:57:19 +0000",
"reset_time" : 1348232239
}
}