Common object types

Face

Represents a human face. Note that it might be several faces on a single photo. Different photos of the same person as also considered to be different faces.

  • "id" (number): unique identifier of the face generated by the FindFace Cloud API.
  • "timestamp" (string): time of face object creation as ISO8601 string.
  • "photo_hash" (string): Hash of the original photo. Note that identical photos will always have the same hash, and different photos will most certainly have different hashes. Don't interpret this value and don't make assumptions about particular hash function used for hash calculation.
  • "x1" (number): x coordinate of the top-left corner of face's bounding box on the original photo.
  • "y1" (number): y coordinate of the top-left corner of face's bounding box on the original photo.
  • "x2" (number): x coordinate of the bottom-right corner of face's bounding box on the original photo.
  • "y2" (number): y coordinate of the bottom-right corner of face's bounding box on the original photo.
  • "meta" (string): metadata string that you can use to store any information associated with the face.
  • "galleries" (string[]): array of galleries names that have this face.
  • "photo" (string): URL of file name of a photo that had been used to create the face object.
  • "thumbnail" (string): URL of face thumbnail stored on FindFace servers.

Bounding box (bbox)

Represents a rectangle on a photo. Usually used as a face's bounding box. May be specified in two ways:
  • As a dictionary:
    • "x1" (number): x coordinate of the top-left corner of the bounding box.
    • "y1" (number): y coordinate of the top-left corner of the bounding box.
    • "x2" (number): x coordinate of the bottom-right corner of the bounding box.
    • "y2" (number): y coordinate of the bottom-right corner of the bounding box.
  • As a list: [x1, y1, x2, y2]

The API methods accept both formats, but always return bbox as a JSON dictionary.

Note that in some case the coordinates might be outside photo dimensions, including negative values.