Cloud API

Retrieve a group by ID

GET https://api.imageintelligence.com/v2/recognition/groups/{namespace}/{id}

Groups are resources created automatically for you in the background. When detected objects (e.g. faces) are found in images through POST /recognize, they are automatically clustered together. This endpoint allows you to retrieve a automatically created group by id.

Request Parameters

NameInDescription
namespace
required		pathstring
id
required		pathstring

The ID of a recognition identity

Response Parameters

Recognition identity resource

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

{
  "id": "ab36de62-fe3e-4907-8a03-7d27c21fa01a",
  "identityId": "af278ded-5412-4916-bc5c-13469bfe7644",
  "batchId": "bf94e979-9205-4681-9b89-6ed11a498ec9",
  "namespace": "acme",
  "linkModifiedBy": "ML",
  "linkLastModifiedAt": 1487648348000,
  "createdAt": 1487648348000,
  "images": [
    {
      "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": "65dd9554-ce46-4a29-bcd7-eeb48683b421",
      "boundingBoxConfidence": 0.9129213,
      "type": "FACE",
      "isFrontal": true,
      "sharpness": 0.671230746,
      "width": 150,
      "height": 200,
      "createdAt": 1487648348000
    }
  ]
}