MemoryWeb FR API (2)

Download OpenAPI specification:Download

JSON API for MemoryWeb - enables facial recognition feature

For more info about how facial recognition process works, check this page.

Face Recognitions

List all recognized faces

query Parameters
token
required
string

API Authentication Token

start
integer
Default: 0

Results offset

count
integer
Default: 10

Number of results

dateModified
string <date-time>

Filters records that are newer from specified timestamp

groupID
integer

Filters records that belong to a specified group

Starts the process for recognizing people on a provided photo

query Parameters
token
required
string

API Authentication Token

mediaAssetID
required
integer

ID of a photo for recognition process

Recognition Groups

List all recognition groups

query Parameters
token
required
string

API Authentication Token

start
integer
Default: 0

Results offset

count
integer
Default: 10

Number of results

dateModified
string <date-time>

Filters records that are newer from specified timestamp

orderBy
string
Value: "photos-desc"

Defines records order
1/ photos-desc

ignored
boolean

List only ignored/skipped groups

unassigned
boolean

List groups with no assigned person

Removes specified faces from their group and adds them to a newly created group

query Parameters
token
required
string

API Authentication Token

faceIDs
required
Array of integers

Face IDs that will form a newly created group

Assigns a person to the specified recognition group

path Parameters
id
integer

ID of recognition group

query Parameters
token
required
string

API Authentication Token

personID
integer

ID of a person

Assigns a person to the specified recognition group

path Parameters
id
integer

ID of recognition group

query Parameters
token
required
string

API Authentication Token

personID
integer

ID of a person

Toggles ignore flag for a recognition group

path Parameters
recognition_group_id
integer

ID of a recognition group

query Parameters
token
required
string

API Authentication Token

Toggles ignore flag for a recognition group

path Parameters
recognition_group_id
integer

ID of a recognition group

query Parameters
token
required
string

API Authentication Token

Recognized People

Unassigns all recognition groups which belong to provided person

path Parameters
id
integer

ID of person

query Parameters
token
required
string

API Authentication Token