Search groups

POST https://api.imageintelligence.com/v2/recognition/groups/{namespace}/search

Search for automatically created groups. This endpoint response with an Array<RecognizeGroupResponse> if resources are found. An empty array is returned otherwise.

Request Parameters

NameInDescription
namespace
required
pathstring

Groups' namespace

limit
optional
bodynumber

Number of maximum objects in the query

Default: 20, Minimum: 1, Maximum: 100

offset
optional
bodynumber

Number of results to skip before returning a result

Default: 0, Minimum: 0, Maximum: 100

start
optional
bodynumber

Search for created after this timestamp

end
optional
bodynumber

Search for created before this timestamp

sortBy
optional
bodystring

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

Request Sample

{
  "limit": 50,
  "start": 1551665066,
  "end": 1551666066,
  "sortBy": "ASC",
  "ids": [
    "99f65ae1-9ce9-495a-891b-418e87c90941",
    "bc98e809-c46b-4792-be3e-c57be414642b",
    "65dd9554-ce46-4a29-bcd7-eeb48683b421"
  ]
}

Response Parameters

A list of jobs found given your search criteria

id
optional
string
identityId
optional
string
batchId
optional
string
namespace
optional
string

Max Length: 128

linkModifiedBy
optional
string

Possible values: MANUAL, ML, HITL

linkLastModifiedAt
optional
number
createdAt
optional
number
images
optional
array[object]
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

xMin
required
number

Format: int32

yMin
required
number

Format: int32

xMax
required
number

Format: int32

yMax
required
number

Format: int32

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

Response Sample

No example found at path v2.definitions.RecognitionGroupsSearchResponse.example