POST https://api.imageintelligence.com/v2/recognition/images/{namespace}/search
Similar to /search
in identities
and groups
, this endpoint provides way to search for images associated with a specified {namespace}
.
Name | In | Description |
---|---|---|
namespace required | path | string |
limit optional | body | number Number of maximum objects in the query Default: 20, Minimum: 1, Maximum: 100 |
offset optional | body | number Number of results to skip before returning a result Default: 0, Minimum: 0, Maximum: 100 |
start optional | body | number Search for created after this timestamp |
end optional | body | number Search for created before this timestamp |
sortBy optional | body | string Sort search by an ID Default: DESC Possible values: ASC, DESC |
ids optional | body | array[string] A list of resource ids to search against (e.g. imageId or identityId) Maximum: 100 |
feedIds optional | body | array[string] A list of user defined feedIds to search against (if null then all resources without a feedId will be returned) Maximum: 20 |
customIds optional | body | array[string] A list of user defined customIds to search against (same null property as feedIds) Maximum: 20 |
A list of images found given your search criteria
id optional | string ID of the image | ||||||||
customId optional | string An arbitrary client specific resource identifier to reference this image (usually UUID) | ||||||||
feedId optional | string User specified ID to reference the source of the images within this job | ||||||||
identityId optional | string Identity ID associated to this resource | ||||||||
url optional | string URL of the image | ||||||||
boundingBox optional | object Bounding box values
| ||||||||
boundingBoxConfidence optional | number Confidence level of the resulting bounding box | ||||||||
type optional | string Type of response e.g. "FACE" Possible values: FACE | ||||||||
groupId optional | string Group that the resource belongs to | ||||||||
isFrontal optional | boolean Whether the image is frontal or not | ||||||||
sharpness optional | number Sharpness of the image | ||||||||
width optional | number Width of the image | ||||||||
height optional | number Height of the image | ||||||||
createdAt optional | number Timestamp of when the job was created |
{
"id": "52547074-a622-11e6-8f61-63f37dc33285",
"customId": "some_person_filled_image",
"feedId": "Camera_123456",
"identityId": "af278ded-5412-4916-bc5c-13469bfe7644",
"url": "https://publicly.available.domain.net/image-001.jpg",
"boundingBox": {
"xMin": 0.23873,
"yMin": 0.23873,
"xMax": 0.75087,
"yMax": 0.96537
},
"groupId": "63652986-b730-4ab8-a175-7914a950e7a0",
"boundingBoxConfidence": 0.9129213,
"type": "FACE",
"isFrontal": true,
"sharpness": 0.67123074,
"width": 150,
"height": 200,
"createdAt": 1487648348000
}