Luna-Faces API (v.4.12.21)

Download OpenAPI specification:Download

'VisionLabs Luna-Faces'

Service is intended for creation and management following entities:

Temporary attributes. A temporary attribute is represented by the following fields: * basic attributes: age, gender, ethnicity and sample id list. Service supposes that basic attributes are as aggregated as a descriptor - from all samples.
- list of descriptors with difference versions. Service supposes that each descriptor was aggregated from all samples
- account id - the attribute owner
- ttl - time to store the attribute in the service
Face. A Face is an user logical entity. A Face contains the following fields:
- user data - some string which user associates with the face
- create time - time of the face creation
- event id - event id associated with the face creation.
- external id - user defined external id (non unique)
- face attributes - basic attributes, list of descriptors difference version and corresponding samples ids.
- account id - the face owner
Lists. The Luna-Faces list is user defined list of faces. Each list is determined by the following data:
- user data - some string which user associates with the list
- create time - time of the list creation
- last update time - time of last attachment or detachment of a face from the list
- faces - list of faces attached to the list

version

get version

get service version

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
500

Content type

application/json

{"Version": {"api": 1,
"major": 0,
"minor": 0,
"patch": 0
}
}

faces

create face

Create a new face.

The face can be attached to one or several lists.

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Content-Type	string Enum: "application/json" "application/msgpack" The request content type header.
Luna-Account-Id required	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: 8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id

Request Body schema:
application/json

event_id	string <uuid> (event_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... the event ID associated with the face creation
external_id	string (external_id) <= 36 characters Default: "" user-defined external id for face.
user_data	string (user_data) <= 128 characters Default: "" user data.
avatar	string <uri-reference> (avatar) <= 256 characters Default: "" avatar for face, references to a sample or a user-defined reference.
lists	Array of strings <uuid> (list_id) [ 1 .. 1000 ] items luna lists for linking face with them.
	(attribute_no_account (attribute_with_descriptors_and_basic_attributes_no_account (object) or attribute_with_basic_attributes_no_account (object) or attribute_with_descriptors_no_account (object))) or attribute_set_by_attribute_id (object) (face_attribute) face attribute. The attribute can be specified by temporary attribute ID or explicitly by attribute data.

Responses

Request samples

Payload

Content type

application/json

Example

create face with attribute specified by attribute data

{"account_id": "0468ca85-f6ca-4841-b30c-5ccc26b6f397",
"event_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
"external_id": "2xQ2gprbMUePw1s9gw9fvA==",
"user_data": "some_string",
"avatar": "https://upload.wikimedia.org/wikipedia/commons/thumb/c/c4/Abbey_Lee_2015.jpg/800px-Abbey_Lee_2015.jpg",
"lists": ["234fc28c-a767-42fc-a0c2-e01ad00b5c59",
"c2a09aff-0116-41cf-a7c7-91631d40d0c2"
],
"attribute": {"basic_attributes": {"age": 18,
"gender": 0,
"ethnicity": 4
},
"basic_attributes_samples": ["0d1cc36e-d719-4f54-8abe-4e5e0cb1f43c",
"2f1cbb34-12e5-486c-8f7f-57273053c32d"
],
"face_descriptors": [{"descriptor": "2xQ2gprbMUePw1s9gw9fvA==",
"version": 46
},
{"descriptor": "1xWqdsdwew32fsdsdw1s9gw9fvA==",
"version": 56
}
],
"face_descriptor_samples": ["ee4c42b6-23ae-410e-a2aa-a4220e64ba4b",
"e909cfbe-29d3-44ed-a949-6cb700b89eba"
]
}
}

Response samples

201
400
403
500

Content type

application/json

{"face_id": "b5d6fd45-fcca-453d-ac05-3e594054b813",
"url": "/2/faces/b5d6fd45-fcca-453d-ac05-3e594054b813"
}

get faces

Get faces according to filters.

query Parameters

account_id	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id
page	integer >= 1 Default: 1 a page number.
page_size	integer [ 1 .. 1000 ] Default: 10 the number of items on page.
create_time__lt	string <date-time> (time) Example: create_time__lt=2018-08-11T09:11:41.674Z upper bound for object create_time.
create_time__gte	string <date-time> (time) Example: create_time__gte=2018-08-11T09:11:41.674Z lower included bound for object create_time.
event_id	string <uuid> the event ID associated with the face creation.
face_ids	string <list of uuid> list of comma-separated face ids.
face_id__lt	string <uuid> upper face id excluding boundary. Faces in response will be sorted by their ids. If neither face_id__lt or face_id__gte is specified, the faces will be sorted by creation time.
face_id__gte	string <uuid> lower face id including boundary. Faces in response will be sorted by their ids. If neither face_id__lt or face_id__gte is specified, the faces will be sorted by creation time.
external_ids	string <list of strings> list of comma-separated external ids.
user_data	string Example: user_data=user_data_text find all objects with `user_data` that is similar to this parameter. You can specify some part of the `user_data` value for this filter.
list_id	string <uuid> (list_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: list_id=429b0e78-4616-426a-b57f-02baa72d638d id of a list that contains faces.
targets	string Default: "face_id,account_id,event_id,external_id,user_data,create_time,avatar,lists" Example: targets=face_id,user_data Comma-separated list of face target fields. Available targets: `face_id`, `account_id`, `event_id`, `external_id`, `user_data`, `create_time`, `avatar`, `lists`

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
400
500

Content type

application/json

{"faces": [{"face_id": "426542d6-5509-4e5b-8a01-e2abd5c0a8c6",
"account_id": "0468ca85-f6ca-4841-b30c-5ccc26b6f397",
"event_id": "f9687459-986b-406d-9c1f-0d6289be5256",
"external_id": "3.1415926",
"user_data": "100-00-12",
"create_time": "2019-08-24T14:15:22Z",
"avatar": "https://upload.wikimedia.org/wikipedia/commons/thumb/2/2d/Yfke-sturm-1326186044.jpg/800px-Yfke-sturm-1326186044.jpg",
"lists": ["429b0e78-4616-426a-b57f-02baa72d638d"
]
}
]
}

delete faces

Delete several faces.

query Parameters

account_id	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id
ignore	integer Default: 0 Enum: 0 1 whether to ignore some face does not exist

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Content-Type	string Enum: "application/json" "application/msgpack" The request content type header.
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Request Body schema:
application/json

face_ids

required

Array of strings <uuid> (face_id) [ 1 .. 1000 ] items

ids of faces for removal

Responses

Request samples

Payload

Content type

application/json

{"face_ids": ["426542d6-5509-4e5b-8a01-e2abd5c0a8c6"
]
}

Response samples

400
404
500

Content type

application/json

{"error_code": 12022,
"desc": "Bad/incomplete input data",
"detail": "Failed to validate input json. Path: '',  message: 'Additional properties are not allowed ('faces' was unexpected)'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12022"
}

delete faces with filters

Delete faces with filters. If targets is empty return status code 204, else return 200.

query Parameters

account_id	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id
targets	string <comma-separated items> Default: "face_id,basic_attributes_samples,face_descriptor_samples" list of comma-separated faces deletion targets. Available targets: `face_id`, `basic_attributes_samples`, `face_descriptor_samples`
create_time__lt	string <date-time> (time) Example: create_time__lt=2018-08-11T09:11:41.674Z upper bound for object create_time.
create_time__gte	string <date-time> (time) Example: create_time__gte=2018-08-11T09:11:41.674Z lower included bound for object create_time.
user_data	string Example: user_data=user_data_text find all objects with `user_data` that is similar to this parameter. You can specify some part of the `user_data` value for this filter.
list_id	string <uuid> (list_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: list_id=429b0e78-4616-426a-b57f-02baa72d638d id of a list that contains faces.

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Content-Type	string Enum: "application/json" "application/msgpack" The request content type header.
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
400
404
500

Content type

application/json

[{"face_id": "426542d6-5509-4e5b-8a01-e2abd5c0a8c6",
"basic_attributes_samples": ["ee4c42b6-23ae-410e-a2aa-a4220e64ba4b",
"e909cfbe-29d3-44ed-a949-6cb700b89eba"
],
"face_descriptor_samples": ["ee4c42b6-23ae-410e-a2aa-a4220e64ba4b",
"e909cfbe-29d3-44ed-a949-6cb700b89eba"
]
}
]

get face count

query Parameters

account_id	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id
create_time__lt	string <date-time> (time) Example: create_time__lt=2018-08-11T09:11:41.674Z upper bound for object create_time.
create_time__gte	string <date-time> (time) Example: create_time__gte=2018-08-11T09:11:41.674Z lower included bound for object create_time.
event_id	string <uuid> the event ID associated with the face creation.
face_ids	string <list of uuid> list of comma-separated face ids.
face_id__lt	string <uuid> upper face id excluding boundary.
face_id__gte	string <uuid> lower face id including boundary.
external_ids	string <list of strings> list of comma-separated external ids.
user_data	string Example: user_data=user_data_text find all objects with `user_data` that is similar to this parameter. You can specify some part of the `user_data` value for this filter.
list_id	string <uuid> (list_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: list_id=429b0e78-4616-426a-b57f-02baa72d638d id of a list that contains faces.

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
400
500

Content type

application/json

{"faces_count": 146
}

get count of faces with attributes

count faces with attributes

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
400
500

Content type

application/json

{"faces_count": 146
}

put face

Put face.

The face can be attached to one or several lists.

path Parameters

face_id

required

string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515

ID of the face (face_id received in the "create face" request).

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Content-Type	string Enum: "application/json" "application/msgpack" The request content type header.
Luna-Account-Id required	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: 8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id

Request Body schema:
application/json

event_id	string <uuid> (event_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... the event ID associated with the face creation
external_id	string (external_id) <= 36 characters Default: "" user-defined external id for face.
user_data	string (user_data) <= 128 characters Default: "" user data.
avatar	string <uri-reference> (avatar) <= 256 characters Default: "" avatar for face, references to a sample or a user-defined reference.
lists	Array of strings <uuid> (list_id) [ 1 .. 1000 ] items luna lists for linking face with them.
	(attribute_no_account (attribute_with_descriptors_and_basic_attributes_no_account (object) or attribute_with_basic_attributes_no_account (object) or attribute_with_descriptors_no_account (object))) or attribute_set_by_attribute_id (object) (face_attribute) face attribute. The attribute can be specified by temporary attribute ID or explicitly by attribute data.

Responses

Request samples

Payload

Content type

application/json

Example

put face with attribute specified by attribute data

{"account_id": "0468ca85-f6ca-4841-b30c-5ccc26b6f397",
"event_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
"external_id": "2xQ2gprbMUePw1s9gw9fvA==",
"user_data": "some_string",
"avatar": "https://upload.wikimedia.org/wikipedia/commons/thumb/c/c4/Abbey_Lee_2015.jpg/800px-Abbey_Lee_2015.jpg",
"lists": ["234fc28c-a767-42fc-a0c2-e01ad00b5c59",
"c2a09aff-0116-41cf-a7c7-91631d40d0c2"
],
"attribute": {"basic_attributes": {"age": 18,
"gender": 0,
"ethnicity": 4
},
"basic_attributes_samples": ["0d1cc36e-d719-4f54-8abe-4e5e0cb1f43c",
"2f1cbb34-12e5-486c-8f7f-57273053c32d"
],
"face_descriptors": [{"descriptor": "2xQ2gprbMUePw1s9gw9fvA==",
"version": 46
},
{"descriptor": "1xWqdsdwew32fsdsdw1s9gw9fvA==",
"version": 56
}
],
"face_descriptor_samples": ["ee4c42b6-23ae-410e-a2aa-a4220e64ba4b",
"e909cfbe-29d3-44ed-a949-6cb700b89eba"
]
}
}

Response samples

200
400
403
404
500

Content type

application/json

{"face_id": "b5d6fd45-fcca-453d-ac05-3e594054b813",
"url": "/2/faces/b5d6fd45-fcca-453d-ac05-3e594054b813"
}

get face

Get face by ID.

NOTE: To get the face attribute data use method GET on /faces/{face_id}/attributes.

path Parameters

face_id

required

string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515

ID of the face (face_id received in the "create face" request).

query Parameters

account_id	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id
targets	string Default: "face_id,account_id,event_id,external_id,user_data,create_time,avatar,lists" Example: targets=face_id,user_data Comma-separated list of face target fields. Available targets: `face_id`, `account_id`, `event_id`, `external_id`, `user_data`, `create_time`, `avatar`, `lists`

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
400
404
500

Content type

application/json

{"face_id": "426542d6-5509-4e5b-8a01-e2abd5c0a8c6",
"account_id": "0468ca85-f6ca-4841-b30c-5ccc26b6f397",
"event_id": "f9687459-986b-406d-9c1f-0d6289be5256",
"external_id": "3.1415926",
"user_data": "100-00-12",
"create_time": "2019-08-24T14:15:22Z",
"avatar": "https://upload.wikimedia.org/wikipedia/commons/thumb/2/2d/Yfke-sturm-1326186044.jpg/800px-Yfke-sturm-1326186044.jpg",
"lists": ["429b0e78-4616-426a-b57f-02baa72d638d"
]
}

check face existence

Check existence of the face by ID.

path Parameters

face_id

required

string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515

ID of the face (face_id received in the "create face" request).

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

400
404
500

Content type

application/json

{"error_code": 12012,
"desc": "Bad/incomplete input data",
"detail": "Bad query parameters 'account_id'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12012"
}

update face

Update face fields: user_data, avatar, external_id, event_id.

NOTE: To update the face attribute data use method PATCH on /faces/{face_id}/attributes.

path Parameters

face_id

required

string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515

ID of the face (face_id received in the "create face" request).

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Content-Type	string Enum: "application/json" "application/msgpack" The request content type header.

Request Body schema:
application/json

event_id	string or null <uuid> (event_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... the event ID associated with the face creation
external_id	string (external_id) <= 36 characters Default: "" user-defined external id for face.
user_data	string (user_data) <= 128 characters Default: "" user data.
avatar	string <uri-reference> (avatar) <= 256 characters Default: "" avatar for face, references to a sample or a user-defined reference.

Responses

Request samples

Payload

Content type

application/json

{"event_id": "f9687459-986b-406d-9c1f-0d6289be5256",
"external_id": "3.1415926",
"user_data": "100-00-12",
"avatar": "https://upload.wikimedia.org/wikipedia/commons/thumb/2/2d/Yfke-sturm-1326186044.jpg/800px-Yfke-sturm-1326186044.jpg"
}

Response samples

400
404
500

Content type

application/json

Example

bad_content_type

{"error_code": 12017,
"desc": "Bad/incomplete input data",
"detail": "Bad content type",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12017"
}

delete face

Remove face by ID.

path Parameters

face_id

required

string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515

ID of the face (face_id received in the "create face" request).

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

400
404
500

Content type

application/json

{"error_code": 12012,
"desc": "Bad/incomplete input data",
"detail": "Bad query parameters 'account_id'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12012"
}

face attributes

put face attribute

Put face attribute.

The attribute can be specified by temporary attribute ID or explicitly by attribute data.

path Parameters

face_id

required

string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515

ID of the face (face_id received in the "create face" request).

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Content-Type	string Enum: "application/json" "application/msgpack" The request content type header.

Request Body schema:
application/json

One of

required	object (basic_attributes) basic attributes. Each basic attribute was aggregated from the samples. Samples is needed for re-extract attributes of new algorithm version and visualisation.
basic_attributes_samples	Array of strings <uuid> (attributes_samples) [ 0 .. 1000 ] items unique Default: [] list of uniqie sample ids which are resources for estimation attributes. WARNING: if user does not set any attributes samples faces with such attributes will be skipped in a process of updating attributes with using new estimation algorithm.
required	Array of descriptor_data (object) or sdk_descriptor_base64 (string) (face_descriptors) [ 1 .. 1000 ] items list of descriptors with different versions. Each descriptor was aggregated descriptor from the samples
face_descriptor_samples	Array of strings <uuid> (attributes_samples) [ 0 .. 1000 ] items unique Default: [] list of uniqie sample ids which are resources for estimation attributes. WARNING: if user does not set any attributes samples faces with such attributes will be skipped in a process of updating attributes with using new estimation algorithm.

Responses

Request samples

Payload

Content type

application/json

Example

put face attribute specified by attribute data

{"basic_attributes": {"age": 18,
"gender": 0,
"ethnicity": 4
},
"basic_attributes_samples": ["0d1cc36e-d719-4f54-8abe-4e5e0cb1f43c",
"2f1cbb34-12e5-486c-8f7f-57273053c32d"
],
"face_descriptors": [{"descriptor": "2xQ2gprbMUePw1s9gw9fvA==",
"version": 46
},
{"descriptor": "1xWqdsdwew32fsdsdw1s9gw9fvA==",
"version": 56
}
],
"face_descriptor_samples": ["ee4c42b6-23ae-410e-a2aa-a4220e64ba4b",
"e909cfbe-29d3-44ed-a949-6cb700b89eba"
]
}

Response samples

400
403
404
500

Content type

application/json

Example

bad_json

{"error_code": 12022,
"desc": "Bad/incomplete input data",
"detail": "Failed to validate input json. Path: '',  message: 'Additional properties are not allowed ('userdata' was unexpected)'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12022"
}

get face attribute

Get face attribute by ID.

path Parameters

face_id

required

string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515

ID of the face (face_id received in the "create face" request).

query Parameters

account_id	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id
descriptor_format	integer Default: "raw" Enum: "raw" "sdk" output descriptor format.
targets	string <comma-separated items> Default: "create_time,basic_attributes,basic_attributes_samples,face_descriptor,face_descriptor_samples" list of comma-separated temporary attributes targets. Available targets: `create_time`, `basic_attributes`, `basic_attributes_samples`, `face_descriptor`, `face_descriptor_samples`
descriptor_version	integer (descriptor_version) Enum: 46 52 54 56 57 58 59 60 62 64 Example: descriptor_version=56 descriptor version of the face descriptor attribute in response. By default used the platform defualt descriptor version.

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
400
404
500

Content type

application/json

{"attributes": {"create_time": "2018-08-11T09:11:41.674Z",
"basic_attributes": {"age": 35,
"gender": 0,
"ethnicity": 1
},
"face_descriptor": {"descriptor": "2xQ2gprbMUePw1s9gw9fvA==",
"descriptor_version": 56
},
"basic_attributes_samples": ["ee4c42b6-23ae-410e-a2aa-a4220e64ba4b",
"e909cfbe-29d3-44ed-a949-6cb700b89eba"
],
"face_descriptor_samples": ["ee4c42b6-23ae-410e-a2aa-a4220e64ba4b",
"e909cfbe-29d3-44ed-a949-6cb700b89eba"
]
}
}

update face attribute

Update face attribute data: basic_attributes, basic_attributes_samples, face_descriptor, face_descriptor_samples.

path Parameters

face_id

required

string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515

ID of the face (face_id received in the "create face" request).

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Request Body schema:
application/json

One of

required	object (basic_attributes) basic attributes. Each basic attribute was aggregated from the samples. Samples is needed for re-extract attributes of new algorithm version and visualisation.
basic_attributes_samples	Array of strings <uuid> (attributes_samples) [ 0 .. 1000 ] items unique Default: [] list of uniqie sample ids which are resources for estimation attributes. WARNING: if user does not set any attributes samples faces with such attributes will be skipped in a process of updating attributes with using new estimation algorithm.
required	Array of descriptor_data (object) or sdk_descriptor_base64 (string) (face_descriptors) [ 1 .. 1000 ] items list of descriptors with different versions. Each descriptor was aggregated descriptor from the samples
face_descriptor_samples	Array of strings <uuid> (attributes_samples) [ 0 .. 1000 ] items unique Default: [] list of uniqie sample ids which are resources for estimation attributes. WARNING: if user does not set any attributes samples faces with such attributes will be skipped in a process of updating attributes with using new estimation algorithm.

Responses

Request samples

Payload

Content type

application/json

Example

attribute_with_descriptors_and_basic_attributes_no_account

{"basic_attributes": {"age": 35,
"gender": 0,
"ethnicity": 1
},
"basic_attributes_samples": ["ee4c42b6-23ae-410e-a2aa-a4220e64ba4b",
"e909cfbe-29d3-44ed-a949-6cb700b89eba"
],
"face_descriptors": [{"descriptor": "2xQ2gprbMUePw1s9gw9fvA==",
"version": 46
},
{"descriptor": "1xWqdsdwew32fsdsdw1s9gw9fvA==",
"version": 56
}
],
"face_descriptor_samples": ["ee4c42b6-23ae-410e-a2aa-a4220e64ba4b",
"e909cfbe-29d3-44ed-a949-6cb700b89eba"
]
}

Response samples

400
404
500

Content type

application/json

Example

bad_content_type

{"error_code": 12017,
"desc": "Bad/incomplete input data",
"detail": "Bad content type",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12017"
}

delete face attribute

Remove face attribute by ID.

path Parameters

face_id

required

string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515

ID of the face (face_id received in the "create face" request).

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

400
404
500

Content type

application/json

{"error_code": 12012,
"desc": "Bad/incomplete input data",
"detail": "Bad query parameters 'account_id'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12012"
}

get face attribute samples

Get face attribute samples by face ID.

path Parameters

face_id

required

string <uuid> (uuid) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 557d54ec-29ad-4f3c-93b4-c9092ef12515

ID of the face (face_id received in the "create face" request).

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
400
404
500

Content type

application/json

{"samples": ["0d1cc36e-d719-4f54-8abe-4e5e0cb1f43c",
"2f1cbb34-12e5-486c-8f7f-57273053c32d"
]
}

temporary attributes

create a temporary attribute

Creating new temporary attributes. The attribute has a ttl and after an expire the time attribute will be removed from the service.

query Parameters

ttl	integer [ 1 .. 86400 ] Default: 300 lifetime for temporary attribute (seconds)

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Content-Type	string Enum: "application/json" "application/msgpack" "multipart/form-data" Format of a request body data.
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: 8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id

Request Body schema:
application/json

One of

required	Array of descriptor_data (object) or sdk_descriptor_base64 (string) (face_descriptors) [ 1 .. 1000 ] items list of descriptors with different versions. Each descriptor was aggregated descriptor from the samples
face_descriptor_samples	Array of strings <uuid> (attributes_samples) [ 0 .. 1000 ] items unique Default: [] list of uniqie sample ids which are resources for estimation attributes. WARNING: if user does not set any attributes samples faces with such attributes will be skipped in a process of updating attributes with using new estimation algorithm.
required	object (basic_attributes) basic attributes. Each basic attribute was aggregated from the samples. Samples is needed for re-extract attributes of new algorithm version and visualisation.
basic_attributes_samples	Array of strings <uuid> (attributes_samples) [ 0 .. 1000 ] items unique Default: [] list of uniqie sample ids which are resources for estimation attributes. WARNING: if user does not set any attributes samples faces with such attributes will be skipped in a process of updating attributes with using new estimation algorithm.

Responses

Request samples

Payload

Content type

application/json

Example

attribute_with_basic_attributes

{"basic_attributes": {"age": 35,
"gender": 0,
"ethnicity": 1
},
"basic_attributes_samples": ["ee4c42b6-23ae-410e-a2aa-a4220e64ba4b",
"e909cfbe-29d3-44ed-a949-6cb700b89eba"
]
}

Response samples

201
400
500

Content type

application/json

{"attribute_id": "b5d6fd45-fcca-453d-ac05-3e594054b813",
"url": "/3/attributes/b5d6fd45-fcca-453d-ac05-3e594054b813"
}

get temporary attributes

Get temporary attribute by IDs.

query Parameters

attribute_ids required	string <list of uuid> list of comma-separated attribute ids.
account_id	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id
targets	string <comma-separated items> Default: "basic_attributes" Example: targets=basic_attributes,basic_attributes_samples,account_id list of comma-separated temporary attributes targets. Available targets: `face_descriptor`, `basic_attributes`, `basic_attributes_samples`, `face_descriptor_samples`, `account_id`, `create_time`, `attribute_id`
descriptor_version	integer (descriptor_version) Enum: 46 52 54 56 57 58 59 60 62 64 Example: descriptor_version=56 descriptor version of the face descriptor attribute in response. By default used the platform defualt descriptor version.

header Parameters

Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Accept	string Enum: "application/json" "application/msgpack" Which content-type is requested. `application/json` by default

Responses

Response samples

200
400
500

Content type

application/json

Example

default

{"attributes": [{"basic_attributes": {"age": 33,
"gender": 1,
"ethnicity": 3
}
}
]
}

get temporary attributes count

WARNING: there is no ability to get attribute count by accounts

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
500

Content type

application/json

{"attributes_count": 146
}

put temporary attribute

Put temporary attribute by ID.

path Parameters

attribute_id

required

string <uuid> (attribute_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 7fdf9225-3c06-4c21-b774-8bea99bcce20

ID of the temporary attribute.

query Parameters

ttl	integer [ 1 .. 86400 ] Default: 300 lifetime for temporary attribute (seconds)
force	integer Default: 0 Enum: 0 1 replace an attribute if there exist attribute with same attribute_id. If parameter is equal to 0 and attribute with same attribute_id is exists the request will be failed.

header Parameters

Content-Type	string Enum: "application/json" "multipart/form-data" "application/msgpack" Format of a request body data.
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: 8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id

Request Body schema:
application/json

One of

required	Array of descriptor_data (object) or sdk_descriptor_base64 (string) (face_descriptors) [ 1 .. 1000 ] items list of descriptors with different versions. Each descriptor was aggregated descriptor from the samples
face_descriptor_samples	Array of strings <uuid> (attributes_samples) [ 0 .. 1000 ] items unique Default: [] list of uniqie sample ids which are resources for estimation attributes. WARNING: if user does not set any attributes samples faces with such attributes will be skipped in a process of updating attributes with using new estimation algorithm.
required	object (basic_attributes) basic attributes. Each basic attribute was aggregated from the samples. Samples is needed for re-extract attributes of new algorithm version and visualisation.
basic_attributes_samples	Array of strings <uuid> (attributes_samples) [ 0 .. 1000 ] items unique Default: [] list of uniqie sample ids which are resources for estimation attributes. WARNING: if user does not set any attributes samples faces with such attributes will be skipped in a process of updating attributes with using new estimation algorithm.

Responses

Request samples

Payload

Content type

application/json

Example

attribute_with_basic_attributes

{"basic_attributes": {"age": 35,
"gender": 0,
"ethnicity": 1
},
"basic_attributes_samples": ["ee4c42b6-23ae-410e-a2aa-a4220e64ba4b",
"e909cfbe-29d3-44ed-a949-6cb700b89eba"
]
}

Response samples

400
404
409
500

Content type

application/json

Example

bad_query_param

{"error_code": 12012,
"desc": "Bad/incomplete input data",
"detail": "Bad query parameters 'force'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12012"
}

get temporary attribute

Get temporary attribute by ID.

path Parameters

attribute_id

required

string <uuid> (attribute_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 7fdf9225-3c06-4c21-b774-8bea99bcce20

ID of the temporary attribute.

query Parameters

descriptor_version	integer (descriptor_version) Enum: 46 52 54 56 57 58 59 60 62 64 Example: descriptor_version=56 descriptor version of the face descriptor attribute in response. By default used the platform defualt descriptor version.
account_id	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id
targets	string <comma-separated items> Default: "basic_attributes" Example: targets=basic_attributes,basic_attributes_samples,account_id list of comma-separated temporary attributes targets. Available targets: `face_descriptor`, `basic_attributes`, `basic_attributes_samples`, `face_descriptor_samples`, `account_id`, `create_time`, `attribute_id`

header Parameters

Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Accept	string Enum: "application/json" "application/msgpack" Which content-type is requested. `application/json` by default
Accept	string Enum: "application/json" "application/msgpack" Preferred response content type

Responses

Response samples

200
400
404
500

Content type

application/msgpack

No sample

check temporary attribute

Check temporary attribute existence.

path Parameters

attribute_id

required

string <uuid> (attribute_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 7fdf9225-3c06-4c21-b774-8bea99bcce20

ID of the temporary attribute.

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

delete attribute

Delete the attribute by its ID.

path Parameters

attribute_id

required

string <uuid> (attribute_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 7fdf9225-3c06-4c21-b774-8bea99bcce20

ID of the temporary attribute.

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

400
404
500

Content type

application/json

{"error_code": 12012,
"desc": "Bad/incomplete input data",
"detail": "Bad query parameters 'account_id'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12012"
}

get temporary attribute samples

get all the temporary attribute samples by the attribute ID.

path Parameters

attribute_id

required

string <uuid> (attribute_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 7fdf9225-3c06-4c21-b774-8bea99bcce20

id of the temporary attribute.

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
400
404
500

Content type

application/json

{"samples": ["0d1cc36e-d719-4f54-8abe-4e5e0cb1f43c",
"2f1cbb34-12e5-486c-8f7f-57273053c32d"
]
}

descriptors_caching

get face descriptor batches

Get face descriptors using face ids or list id with filters. Returns requested descriptors as SDKData object

query Parameters

check_existence	integer Enum: 0 1 whether to check requested objects' existense
parity	integer Enum: 0 1 keys' parity: 0 for even keys in batch and 1 for odd keys, parity filter is not used if not set
receive_external_id	integer Enum: 0 1 whether to return external ids in the response

header Parameters

Content-Type

string

Enum: "application/json" "application/msgpack"

The request content type header.

Request Body schema:
application/json

One of

face_ids

required

Array of strings <uuid> (face_id) <= 1000 items

face ids of faces whose descriptors should be obtained

Responses

Request samples

Payload

Content type

application/json

Example

post_attributes_batches_faces

{"face_ids": ["426542d6-5509-4e5b-8a01-e2abd5c0a8c6"
]
}

Response samples

400
500

Content type

application/json

Example

bad_query_param

{"error_code": 12012,
"desc": "Bad/incomplete input data",
"detail": "Bad query parameters 'parity'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12012"
}

get list attributes

Get list attributes' link keys

path Parameters

list_id

required

string <uuid> (list_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 429b0e78-4616-426a-b57f-02baa72d638d

list id (list_id received in the "create list" response)

query Parameters

link_key__lt	integer (link_key) >= 0 the upper excluding link_key boundary
link_key__gte	integer (link_key) >= 0 the lower including link_key boundary
limit	integer (limit) >= 1 the maximum count of results in the reply
parity	integer Enum: 0 1 keys' parity: 0 for even keys in batch and 1 for odd keys, parity filter is not used if not set

header Parameters

Accept

string

Enum: "application/json" "application/msgpack"

Preferred response content type

Responses

Response samples

200
400
404
500

Content type

application/json

[{"attribute_id": "7fdf9225-3c06-4c21-b774-8bea99bcce20",
"link_key": 0
}
]

get unlinked attributes

Get ids and link and unlink keys for each unlinked attribute.

path Parameters

list_id

required

string <uuid> (list_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 429b0e78-4616-426a-b57f-02baa72d638d

list id (list_id received in the "create list" response)

query Parameters

unlink_key__lt	integer (unlink_key) >= 0 the upper excluding unlink_key boundary
unlink_key__gte	integer (unlink_key) >= 0 the lower including unlink_key boundary
limit	integer (limit) >= 1 the maximum count of results in the reply
parity	integer Enum: 0 1 keys' parity: 0 for even keys in batch and 1 for odd keys, parity filter is not used if not set

header Parameters

Accept

string

Enum: "application/json" "application/msgpack"

Preferred response content type

Responses

Response samples

200
400
404
500

Content type

application/json

[{"attributes_id": "7fdf9225-3c06-4c21-b774-8bea99bcce20",
"link_key": 0,
"unlink_key": 0
}
]

get lists' link and unlink keys

Get lists with link and unlink keys grouped by list ids

query Parameters

use_parity

integer

Enum: 0 1

link/unlink keys' parity - if 0 get max link/unlink keys, if 1 get max even and odd link/unlink keys separetely

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Content-Type	string Enum: "application/json" "application/msgpack" The request content type header.

Request Body schema:
application/json

list_ids

required

Array of strings <uuid> (list_id) <= 1000 items

target list ids to get max link/unlink keys info

Responses

Request samples

Payload

Content type

application/json

{"list_ids": ["429b0e78-4616-426a-b57f-02baa72d638d"
]
}

Response samples

200
400
404
500

Content type

application/json

Example

post_linkkeys_reply_no_parity

{"lists": [{"list_id": "429b0e78-4616-426a-b57f-02baa72d638d",
"link_key": 0,
"unlink_key": 0
}
]
}

lists

create a list

Creating new list.

query Parameters

list_id

string <uuid> (list_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: list_id=429b0e78-4616-426a-b57f-02baa72d638d

id of a list that contains faces.

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Content-Type	string Enum: "application/json" "application/msgpack" The request content type header.
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: 8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id

Request Body schema:
application/json

user_data

string (user_data) <= 128 characters

Default: ""

user data.

Responses

Request samples

Payload

Content type

application/json

{"user_data": "100-00-12"
}

Response samples

201
400
409
500

Content type

application/json

{"list_id": "b5d6fd45-fcca-453d-ac05-3e594054b813",
"url": "/2/lists/b5d6fd45-fcca-453d-ac05-3e594054b813"
}

get lists

get lists by filters.

query Parameters

account_id	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id
page	integer >= 1 Default: 1 a page number.
page_size	integer [ 1 .. 1000 ] Default: 10 the number of items on page.
user_data	string Example: user_data=user_data_text find all objects with `user_data` that is similar to this parameter. You can specify some part of the `user_data` value for this filter.
user_data__eq	string Example: user_data__eq=user_data_text find all objects with same `user_data`.
create_time__lt	string <date-time> (time) Example: create_time__lt=2018-08-11T09:11:41.674Z upper bound for object create_time.
create_time__gte	string <date-time> (time) Example: create_time__gte=2018-08-11T09:11:41.674Z lower included bound for object create_time.
last_update_time__lt	string <date-time> (time) Example: last_update_time__lt=2018-08-11T09:11:41.674Z upper bound for object create_time.
last_update_time__gte	string <date-time> (time) Example: last_update_time__gte=2018-08-11T09:11:41.674Z lower included bound for object create_time.
list_ids	string <list of uuid> list of comma-separated list ids.
list_id__lt	string <uuid> upper list id excluding boundary.
list_id__gte	string <uuid> lower list id including boundary.

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
400
500

Content type

application/json

{"lists": [{"list_id": "6fe44310-f82e-4487-bd01-4cbda03a5ac1",
"account_id": "f7018bef-9c89-4a30-931e-2c00cf58c42a",
"create_time": "2018-08-11T09:11:41.674Z",
"last_update_time": "2018-09-05T09:11:41.674Z",
"user_data": "bad guys"
}
]
}

delete lists

Delete several lists.

query Parameters

account_id	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id
with_faces	integer Default: 0 Enum: 0 1 whether to delete list with all its' faces

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Content-Type	string Enum: "application/json" "application/msgpack" The request content type header.
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Request Body schema:
application/json

list_ids

required

Array of strings <uuid> (list_id) [ 1 .. 1000 ] items

ids of list for removal

Responses

Request samples

Payload

Content type

application/json

{"list_ids": ["429b0e78-4616-426a-b57f-02baa72d638d"
]
}

Response samples

400
500

Content type

application/json

{"error_code": 12022,
"desc": "Bad/incomplete input data",
"detail": "Failed to validate input json. Path: '',  message: 'Additional properties are not allowed ('faces' was unexpected)'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12022"
}

get lists count

query Parameters

account_id	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id
user_data	string Example: user_data=user_data_text find all objects with `user_data` that is similar to this parameter. You can specify some part of the `user_data` value for this filter.
user_data__eq	string Example: user_data__eq=user_data_text find all objects with same `user_data`.
create_time__lt	string <date-time> (time) Example: create_time__lt=2018-08-11T09:11:41.674Z upper bound for object create_time.
create_time__gte	string <date-time> (time) Example: create_time__gte=2018-08-11T09:11:41.674Z lower included bound for object create_time.
last_update_time__lt	string <date-time> (time) Example: last_update_time__lt=2018-08-11T09:11:41.674Z upper bound for object create_time.
last_update_time__gte	string <date-time> (time) Example: last_update_time__gte=2018-08-11T09:11:41.674Z lower included bound for object create_time.
list_ids	string <list of uuid> list of comma-separated list ids.
list_id__lt	string <uuid> upper list id excluding boundary.
list_id__gte	string <uuid> lower list id including boundary.

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
400
500

Content type

application/json

{"lists_count": 146
}

get list

Get list by id

path Parameters

list_id

required

string <uuid> (list_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 429b0e78-4616-426a-b57f-02baa72d638d

list id (list_id received in the "create list" response)

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
400
404
500

Content type

application/json

{"account_id": "0468ca85-f6ca-4841-b30c-5ccc26b6f397",
"list_id": "429b0e78-4616-426a-b57f-02baa72d638d",
"user_data": "string",
"create_time": "string",
"last_update_time": "string"
}

check list existence

Check existence of the list with id=list_id.

path Parameters

list_id

required

string <uuid> (list_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 429b0e78-4616-426a-b57f-02baa72d638d

list id (list_id received in the "create list" response)

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

{"error_code": 1,
"detail": "internal server error",
"desc": "internal server error",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-1"
}

update list

Update the user_data field of the list.

path Parameters

list_id

required

string <uuid> (list_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 429b0e78-4616-426a-b57f-02baa72d638d

list id (list_id received in the "create list" response)

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Content-Type	string Enum: "application/json" "application/msgpack" The request content type header.

Request Body schema:
application/json

user_data

required

string <= 128 characters

Default: ""

user data.

Responses

Request samples

Payload

Content type

application/json

{"user_data": "string"
}

Response samples

400
404
500

Content type

application/json

Example

bad_content_type

{"error_code": 12017,
"desc": "Bad/incomplete input data",
"detail": "Bad content type",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12017"
}

remove list

Remove list by id

path Parameters

list_id

required

string <uuid> (list_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: 429b0e78-4616-426a-b57f-02baa72d638d

list id (list_id received in the "create list" response)

query Parameters

account_id	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id
with_faces	integer Default: 0 Enum: 0 1 whether to delete list with all its' faces

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

400
404
500

Content type

application/json

{"error_code": 12012,
"desc": "Bad/incomplete input data",
"detail": "Bad query parameters 'account_id'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12012"
}

administration

get lists deletions

Get a log of deleted lists. The method is intended for auditing and tracking deleted lists.

query Parameters

deletion_time__lt	string <date-time> (time) Example: deletion_time__lt=2018-08-11T09:11:41.674Z upper bound for list deletion time.
deletion_time__gte	string <date-time> (time) Example: deletion_time__gte=2018-08-11T09:11:41.674Z lower included bound for list deletion time.
page	integer >= 1 Default: 1 a page number.
page_size	integer [ 1 .. 1000 ] Default: 10 the number of items on page.

Responses

Response samples

200
400
500

Content type

application/json

{"removed_lists": [{"list_id": "4230d3d3-173a-47b6-a4e3-28e0620bf323",
"deletion_id": 146,
"account_id": "95660f66-cf18-4518-be21-09214756a6f9",
"create_time": "2021-02-15T15:01:52.348098+03:00",
"deletion_time": "2021-03-15T15:01:53.169921+03:00"
}
]
}

clear lists deletions log

Clear lists deletions log. It is not recommended to remove all the records from the log. Save last-day records for correct operation of third-party caching mechanisms (matcher).

query Parameters

deletion_time__lt

required

string <date-time> (time)

Example: deletion_time__lt=2018-08-11T09:11:41.674Z

upper bound for list deletion time.

Responses

Response samples

400
500

Content type

application/json

Example

bad_query_param

{"error_code": 12012,
"desc": "Bad/incomplete input data",
"detail": "Bad query parameters 'deletion_time__lt'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12012"
}

get faces without descriptor

Get faces:

without descriptors of the missing_version
with descriptor of a default version
with samples

query Parameters

missing_version required	integer a face descriptor of this version must be missing
account_id	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id
face_id__lt	string <uuid> upper face id excluding boundary.
face_id__gte	string <uuid> lower face id including boundary.
limit	integer (missing_limit) [ 1 .. 1000 ] the maximum count of faces in the reply

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Content-Type	string Enum: "application/json" "application/msgpack" The request content type header.

Request Body schema:
application/json

face_ids

required

Array of strings <uuid> (face_id) [ 1 .. 1000 ] items

ids of faces for search

Responses

Request samples

Payload

Content type

application/json

{"face_ids": ["426542d6-5509-4e5b-8a01-e2abd5c0a8c6"
]
}

Response samples

200
400
500

Content type

application/json

{"faces": [{"face_id": "426542d6-5509-4e5b-8a01-e2abd5c0a8c6",
"samples": ["ee4c42b6-23ae-410e-a2aa-a4220e64ba4b",
"e909cfbe-29d3-44ed-a949-6cb700b89eba"
]
}
]
}

get face count without descriptor

Get face without descriptrs input version count and with descriptor of a default version

query Parameters

missing_version required	integer a face descriptor of this version must be missing
account_id	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id
face_id__lt	string <uuid> upper face id excluding boundary.
face_id__gte	string <uuid> lower face id including boundary.

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Content-Type	string Enum: "application/json" "application/msgpack" The request content type header.

Request Body schema:
application/json

face_ids

required

Array of strings <uuid> (face_id) [ 1 .. 1000 ] items

ids of faces for search

Responses

Request samples

Payload

Content type

application/json

{"face_ids": ["426542d6-5509-4e5b-8a01-e2abd5c0a8c6"
]
}

Response samples

200
400
500

Content type

application/json

{"faces_count": 146
}

get descriptor count info

Get information of the count of descriptors of available versions

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Accept

string

Enum: "application/json" "application/msgpack"

Preferred response content type

Responses

Response samples

200
400
500

Content type

application/json

{"descriptor_count_info": [{"descriptor_version": 56,
"descriptor_count": 0
}
]
}

get faces without basic attributes

Get faces that do not have basic attributes.

The response will include face IDs and their samples. If a face has no samples, the array of samples will be empty.

query Parameters

account_id	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id
face_id__lt	string <uuid> upper face id excluding boundary.
face_id__gte	string <uuid> lower face id including boundary.
limit	integer (missing_limit) [ 1 .. 1000 ] the maximum count of faces in the reply

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Content-Type	string Enum: "application/json" "application/msgpack" The request content type header.

Request Body schema:
application/json

face_ids

required

Array of strings <uuid> (face_id) [ 1 .. 1000 ] items

ids of faces for search

Responses

Request samples

Payload

Content type

application/json

{"face_ids": ["426542d6-5509-4e5b-8a01-e2abd5c0a8c6"
]
}

Response samples

200
400
500

Content type

application/json

{"faces": [{"face_id": "426542d6-5509-4e5b-8a01-e2abd5c0a8c6",
"samples": ["ee4c42b6-23ae-410e-a2aa-a4220e64ba4b",
"e909cfbe-29d3-44ed-a949-6cb700b89eba"
]
}
]
}

get face count without basic attributes

Count faces without basic attributes.

query Parameters

account_id	string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb luna account id
face_id__lt	string <uuid> upper face id excluding boundary.
face_id__gte	string <uuid> lower face id including boundary.

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Content-Type	string Enum: "application/json" "application/msgpack" The request content type header.

Request Body schema:
application/json

face_ids

required

Array of strings <uuid> (face_id) [ 1 .. 1000 ] items

ids of faces for search

Responses

Request samples

Payload

Content type

application/json

{"face_ids": ["426542d6-5509-4e5b-8a01-e2abd5c0a8c6"
]
}

Response samples

200
400
500

Content type

application/json

{"faces_count": 146
}

get basic attributes count info

Count basic attributes saved to the Faces database.

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Accept

string

Enum: "application/json" "application/msgpack"

Preferred response content type

Responses

Response samples

200
400
500

Content type

application/json

{"basic_attributes_count": 0
}

delete face descriptors by version

Delete face descriptors by version

path Parameters

version

required

integer

descriptor version for deletion

query Parameters

face_id__lt	string <uuid> upper face id excluding boundary.
face_id__gte	string <uuid> lower face id including boundary.

header Parameters

Accept

string

Enum: "application/json" "application/msgpack"

Preferred response content type

Responses

Response samples

200
400
500

Content type

application/json

{"face_ids": ["426542d6-5509-4e5b-8a01-e2abd5c0a8c6"
]
}

linker

link (or unlink) faces to a list

query Parameters

account_id

string <uuid> (account_id) ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]...

Example: account_id=8950722f-3fd4-4223-b48f-03f95f0e8dfb

luna account id

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Content-Type	string Enum: "application/json" "application/msgpack" The request content type header.

Request Body schema:
application/json

action required	string Enum: "attach" "detach" action to perform: attach faces to list or detach
face_ids required	Array of strings <uuid> (uuid) <= 1000 items face ids
list_id required	string <uuid> ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]... list id

Responses

Request samples

Payload

Content type

application/json

{"action": "attach",
"face_ids": ["557d54ec-29ad-4f3c-93b4-c9092ef12515"
],
"list_id": "string"
}

Response samples

400
500

Content type

application/json

{"error_code": 12012,
"desc": "Bad/incomplete input data",
"detail": "Bad query parameters 'account_id'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12012"
}

unlink_history

Clean unlink log

Clean history of unlink attributes from lists. This history is required for correct update cash in matchers.

query Parameters

time__lt

string <date-time> (time)

Example: time__lt=2018-08-11T09:11:41.674Z

Upper bound of log time with timezone excluding boundary. This time should be less than now minus last matcher cache update period; otherwise one should drop matchers' caches after performing this request: otherwise some removed faces can be found in match candidates.

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

400
500

Content type

application/json

{"error_code": 12012,
"desc": "Bad/incomplete input data",
"detail": "Bad query parameters 'time__lt'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12012"
}

documents

get openapi documentation

Get service OpenApi documentation. If Accept request header is of type application/x-yaml, returns documentation in yaml format or returns html documentation, if Accept-Type is text/html

header Parameters

Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Accept required	string (accept_docs_handler) Enum: "application/x-yaml" "text/html" acceptable type of receiving data

Responses

Response samples

415
500

Content type

application/json

{"error_code": 12024,
"detail": "Bad/incomplete input data",
"desc": "Unsupported media type",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12024"
}

get development manual

Get sphinx documentation - Development Manual. After the request you will be redirected to the page /docs/dev/index.html

header Parameters

Accept	string Enum: "application/json" "application/msgpack" Preferred response content type
Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

{"error_code": 1,
"detail": "internal server error",
"desc": "internal server error",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-1"
}

config

get service configuration

Get service configuration. Passwords and tokens will be hidden in the response.

header Parameters

Luna-Request-Id	string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4... Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.
Accept	string Enum: "application/json" "text/plain" acceptable type of receiving data

Responses

Response samples

200
415
500

Content type

application/json

{"INFLUX_MONITORING": {"SEND_DATA_FOR_MONITORING": 0,
"VERSION": 2,
"ORGANIZATION": "ORGANIZATION_NAME",
"TOKEN": "********",
"BUCKET": "luna_monitoring",
"HOST": "127.0.0.1",
"PORT": 8086,
"USE_SSL": 0,
"FLUSHING_PERIOD": 1
}
}

plugins

get list of plugins

Get list of service plugins

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
500

Content type

application/json

{"plugins": [{"name": "foo",
"running": 1
}
]
}

metrics

get service requests statistics

Get statistics of success and failed requests to the service in prometheus format.

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
403
500

Content type

text/plain

# HELP request_count_total Counter of requests
# TYPE request_count_total counter
request_count_total{path="GET:/healthcheck",status_code="200"} 1.0

health

get health

get health of service

query Parameters

include_luna_services

integer

Default: 0

Enum: 0 1

Whether to perform healthchecks for dependent luna services.

header Parameters

Luna-Request-Id

string <timestamp,uuid> ^[0-9]{10},[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4...

Example: 1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a

external request id. Helps to uniquely identify messages that correspond to particular requests, in system logs. If it was not set, system will set it in default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
500
502

Content type

application/json

{"execution_time": 0.123
}

Luna-Faces API (v.4.12.21)

version

get version

header Parameters

Responses

Response samples

faces

create face

header Parameters

Request Body schema: application/jsonapplication/msgpackapplication/json

Responses

Request samples

Response samples

get faces

query Parameters

header Parameters

Responses

Response samples

delete faces

query Parameters

header Parameters

Request Body schema: application/jsonapplication/msgpackapplication/json

Responses

Request samples

Response samples

delete faces with filters

query Parameters

header Parameters

Responses

Response samples

get face count

query Parameters

header Parameters

Responses

Response samples

get count of faces with attributes

query Parameters

header Parameters

Responses

Response samples

put face

path Parameters

header Parameters

Request Body schema: application/jsonapplication/msgpackapplication/json

Responses

Request samples

Response samples

get face

path Parameters

query Parameters

header Parameters

Responses

Response samples

check face existence

path Parameters

query Parameters

header Parameters

Responses

Response samples

update face

path Parameters

query Parameters

header Parameters

Request Body schema: application/jsonapplication/msgpackapplication/json

Responses

Request samples

Response samples

delete face

path Parameters

query Parameters

header Parameters

Responses

Response samples

face attributes

put face attribute

path Parameters

query Parameters

header Parameters

Request Body schema: application/jsonapplication/msgpackapplication/json

Responses

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json