Download OpenAPI specification:Download
'VisionLabs Luna-Faces'
Service is intended for creation and management following entities:
get service version
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. |
{- "Version": {
- "api": 1,
- "major": 0,
- "minor": 0,
- "patch": 0
}
}
Create a new face.
The face can be attached to one or several lists.
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 |
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. |
{- "account_id": "0468ca85-f6ca-4841-b30c-5ccc26b6f397",
- "event_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "external_id": "2xQ2gprbMUePw1s9gw9fvA==",
- "user_data": "some_string",
- "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"
]
}
}
{- "face_id": "b5d6fd45-fcca-453d-ac05-3e594054b813",
- "url": "/2/faces/b5d6fd45-fcca-453d-ac05-3e594054b813"
}
Get faces according to filters.
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 |
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: |
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. |
{- "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",
- "lists": [
- "429b0e78-4616-426a-b57f-02baa72d638d"
]
}
]
}
Delete several faces.
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 |
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. |
face_ids required | Array of strings <uuid> (face_id) [ 1 .. 1000 ] items ids of faces for removal |
{- "face_ids": [
- "426542d6-5509-4e5b-8a01-e2abd5c0a8c6"
]
}
{- "error_code": 12022,
- "desc": "Bad/incomplete input data",
- "detail": "Failed to validate input json. Path: '', message: 'Additional properties are not allowed ('faces' was unexpected)'",
}
Delete faces with filters. If targets is empty return status code 204, else return 200.
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:
|
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 |
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. |
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. |
[- {
- "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
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 |
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. |
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. |
{- "faces_count": 146
}
count faces with attributes
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 |
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. |
{- "faces_count": 146
}
Put face.
The face can be attached to one or several lists.
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 ( |
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 |
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. |
{- "account_id": "0468ca85-f6ca-4841-b30c-5ccc26b6f397",
- "event_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
- "external_id": "2xQ2gprbMUePw1s9gw9fvA==",
- "user_data": "some_string",
- "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"
]
}
}
{- "face_id": "b5d6fd45-fcca-453d-ac05-3e594054b813",
- "url": "/2/faces/b5d6fd45-fcca-453d-ac05-3e594054b813"
}
Get face by ID.
NOTE: To get the face attribute data use method GET on
/faces/{face_id}/attributes
.
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 ( |
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: |
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. |
{- "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",
- "lists": [
- "429b0e78-4616-426a-b57f-02baa72d638d"
]
}
Check existence of the face by ID.
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 ( |
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 |
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. |
{- "error_code": 12012,
- "desc": "Bad/incomplete input data",
- "detail": "Bad query parameters 'account_id'",
}
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
.
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 ( |
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 |
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. |
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. |
{- "event_id": "f9687459-986b-406d-9c1f-0d6289be5256",
- "external_id": "3.1415926",
- "user_data": "100-00-12",
}
{- "error_code": 12017,
- "desc": "Bad/incomplete input data",
- "detail": "Bad content type",
}
Remove face by ID.
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 ( |
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 |
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. |
{- "error_code": 12012,
- "desc": "Bad/incomplete input data",
- "detail": "Bad query parameters 'account_id'",
}
Put face attribute.
The attribute can be specified by temporary attribute ID or explicitly by attribute data.
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 ( |
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 |
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. |
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.
|
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.
|
{- "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"
]
}
{- "error_code": 12022,
- "desc": "Bad/incomplete input data",
- "detail": "Failed to validate input json. Path: '', message: 'Additional properties are not allowed ('userdata' was unexpected)'",
}
Get face attribute by ID.
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 ( |
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:
|
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. |
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. |
{- "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 data: basic_attributes, basic_attributes_samples, face_descriptor, face_descriptor_samples.
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 ( |
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 |
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. |
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.
|
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.
|
{- "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"
]
}
{- "error_code": 12017,
- "desc": "Bad/incomplete input data",
- "detail": "Bad content type",
}
Remove face attribute by ID.
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 ( |
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 |
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. |
{- "error_code": 12012,
- "desc": "Bad/incomplete input data",
- "detail": "Bad query parameters 'account_id'",
}
Get face attribute samples by face ID.
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 ( |
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 |
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. |
{- "samples": [
- "0d1cc36e-d719-4f54-8abe-4e5e0cb1f43c",
- "2f1cbb34-12e5-486c-8f7f-57273053c32d"
]
}
Creating new temporary attributes. The attribute has a ttl and after an expire the time attribute will be removed from the service.
ttl | integer [ 1 .. 86400 ] Default: 300 lifetime for temporary attribute (seconds) |
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 |
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.
|
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.
|
{- "basic_attributes": {
- "age": 35,
- "gender": 0,
- "ethnicity": 1
}, - "basic_attributes_samples": [
- "ee4c42b6-23ae-410e-a2aa-a4220e64ba4b",
- "e909cfbe-29d3-44ed-a949-6cb700b89eba"
]
}
{- "attribute_id": "b5d6fd45-fcca-453d-ac05-3e594054b813",
- "url": "/3/attributes/b5d6fd45-fcca-453d-ac05-3e594054b813"
}
Get temporary attribute by IDs.
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: |
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. |
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. |
{- "attributes": [
- {
- "basic_attributes": {
- "age": 33,
- "gender": 1,
- "ethnicity": 3
}
}
]
}
get temporary attributes count
WARNING: there is no ability to get attribute count by accounts
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. |
{- "attributes_count": 146
}
Put temporary attribute by ID.
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. |
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. |
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 |
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.
|
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.
|
{- "basic_attributes": {
- "age": 35,
- "gender": 0,
- "ethnicity": 1
}, - "basic_attributes_samples": [
- "ee4c42b6-23ae-410e-a2aa-a4220e64ba4b",
- "e909cfbe-29d3-44ed-a949-6cb700b89eba"
]
}
{- "error_code": 12012,
- "desc": "Bad/incomplete input data",
- "detail": "Bad query parameters 'force'",
}
Get temporary attribute by ID.
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. |
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: |
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. |
Accept | string Enum: "application/json" "application/msgpack" Preferred response content type |
Check temporary attribute existence.
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. |
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 |
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. |
Delete the attribute by its ID.
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. |
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 |
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. |
{- "error_code": 12012,
- "desc": "Bad/incomplete input data",
- "detail": "Bad query parameters 'account_id'",
}
get all the temporary attribute samples by the attribute ID.
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. |
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 |
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. |
{- "samples": [
- "0d1cc36e-d719-4f54-8abe-4e5e0cb1f43c",
- "2f1cbb34-12e5-486c-8f7f-57273053c32d"
]
}
Get face descriptors using face ids or list id with filters. Returns requested descriptors as SDKData object
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 |
Content-Type | string Enum: "application/json" "application/msgpack" The request content type header. |
face_ids required | Array of strings <uuid> (face_id) <= 1000 items face ids of faces whose descriptors should be obtained |
{- "face_ids": [
- "426542d6-5509-4e5b-8a01-e2abd5c0a8c6"
]
}
{- "error_code": 12012,
- "desc": "Bad/incomplete input data",
- "detail": "Bad query parameters 'parity'",
}
Get list attributes' link keys
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) |
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 |
Accept | string Enum: "application/json" "application/msgpack" Preferred response content type |
[- {
- "attribute_id": "7fdf9225-3c06-4c21-b774-8bea99bcce20",
- "link_key": 0
}
]
Get ids and link and unlink keys for each unlinked attribute.
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) |
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 |
Accept | string Enum: "application/json" "application/msgpack" Preferred response content type |
[- {
- "attributes_id": "7fdf9225-3c06-4c21-b774-8bea99bcce20",
- "link_key": 0,
- "unlink_key": 0
}
]
Get lists with link and unlink keys grouped by list ids
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 |
Accept | string Enum: "application/json" "application/msgpack" Preferred response content type |
Content-Type | string Enum: "application/json" "application/msgpack" The request content type header. |
list_ids required | Array of strings <uuid> (list_id) <= 1000 items target list ids to get max link/unlink keys info |
{- "list_ids": [
- "429b0e78-4616-426a-b57f-02baa72d638d"
]
}
{- "lists": [
- {
- "list_id": "429b0e78-4616-426a-b57f-02baa72d638d",
- "link_key": 0,
- "unlink_key": 0
}
]
}
Creating new list.
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. |
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 |
user_data | string (user_data) <= 128 characters Default: "" user data. |
{- "user_data": "100-00-12"
}
{- "list_id": "b5d6fd45-fcca-453d-ac05-3e594054b813",
- "url": "/2/lists/b5d6fd45-fcca-453d-ac05-3e594054b813"
}
get lists by filters.
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__eq | string Example: user_data__eq=user_data_text find all objects with same |
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. |
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. |
{- "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 several lists.
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 |
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. |
list_ids required | Array of strings <uuid> (list_id) [ 1 .. 1000 ] items ids of list for removal |
{- "list_ids": [
- "429b0e78-4616-426a-b57f-02baa72d638d"
]
}
{- "error_code": 12022,
- "desc": "Bad/incomplete input data",
- "detail": "Failed to validate input json. Path: '', message: 'Additional properties are not allowed ('faces' was unexpected)'",
}
get lists count
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__eq | string Example: user_data__eq=user_data_text find all objects with same |
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. |
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. |
{- "lists_count": 146
}
Get list by id
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) |
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 |
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. |
{- "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 existence of the list with id=list_id
.
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) |
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 |
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. |
{- "error_code": 1,
- "detail": "internal server error",
- "desc": "internal server error",
}
Update the user_data field of the list.
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) |
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 |
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. |
user_data required | string <= 128 characters Default: "" user data. |
{- "user_data": "string"
}
{- "error_code": 12017,
- "desc": "Bad/incomplete input data",
- "detail": "Bad content type",
}
Remove list by id
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) |
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 |
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. |
{- "error_code": 12012,
- "desc": "Bad/incomplete input data",
- "detail": "Bad query parameters 'account_id'",
}
Get a log of deleted lists. The method is intended for auditing and tracking deleted lists.
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. |
{- "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. 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).
deletion_time__lt required | string <date-time> (time) Example: deletion_time__lt=2018-08-11T09:11:41.674Z upper bound for list deletion time. |
{- "error_code": 12012,
- "desc": "Bad/incomplete input data",
- "detail": "Bad query parameters 'deletion_time__lt'",
}
Get faces:
missing_version
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 |
Accept | string Enum: "application/json" "application/msgpack" Preferred response content type |
Content-Type | string Enum: "application/json" "application/msgpack" The request content type header. |
face_ids required | Array of strings <uuid> (face_id) [ 1 .. 1000 ] items ids of faces for search |
{- "face_ids": [
- "426542d6-5509-4e5b-8a01-e2abd5c0a8c6"
]
}
{- "faces": [
- {
- "face_id": "426542d6-5509-4e5b-8a01-e2abd5c0a8c6",
- "samples": [
- "ee4c42b6-23ae-410e-a2aa-a4220e64ba4b",
- "e909cfbe-29d3-44ed-a949-6cb700b89eba"
]
}
]
}
Get face without descriptrs input version count and with descriptor of a default version
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. |
Accept | string Enum: "application/json" "application/msgpack" Preferred response content type |
Content-Type | string Enum: "application/json" "application/msgpack" The request content type header. |
face_ids required | Array of strings <uuid> (face_id) [ 1 .. 1000 ] items ids of faces for search |
{- "face_ids": [
- "426542d6-5509-4e5b-8a01-e2abd5c0a8c6"
]
}
{- "faces_count": 146
}
Get information of the count of descriptors of available versions
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 |
Accept | string Enum: "application/json" "application/msgpack" Preferred response content type |
{- "descriptor_count_info": [
- {
- "descriptor_version": 56,
- "descriptor_count": 0
}
]
}
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.
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 |
Accept | string Enum: "application/json" "application/msgpack" Preferred response content type |
Content-Type | string Enum: "application/json" "application/msgpack" The request content type header. |
face_ids required | Array of strings <uuid> (face_id) [ 1 .. 1000 ] items ids of faces for search |
{- "face_ids": [
- "426542d6-5509-4e5b-8a01-e2abd5c0a8c6"
]
}
{- "faces": [
- {
- "face_id": "426542d6-5509-4e5b-8a01-e2abd5c0a8c6",
- "samples": [
- "ee4c42b6-23ae-410e-a2aa-a4220e64ba4b",
- "e909cfbe-29d3-44ed-a949-6cb700b89eba"
]
}
]
}
Count faces without basic attributes.
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. |
Accept | string Enum: "application/json" "application/msgpack" Preferred response content type |
Content-Type | string Enum: "application/json" "application/msgpack" The request content type header. |
face_ids required | Array of strings <uuid> (face_id) [ 1 .. 1000 ] items ids of faces for search |
{- "face_ids": [
- "426542d6-5509-4e5b-8a01-e2abd5c0a8c6"
]
}
{- "faces_count": 146
}
Count basic attributes saved to the Faces database.
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 |
Accept | string Enum: "application/json" "application/msgpack" Preferred response content type |
{- "basic_attributes_count": 0
}
Delete face descriptors by version
version required | integer descriptor version for deletion |
face_id__lt | string <uuid> upper face id excluding boundary. |
face_id__gte | string <uuid> lower face id including boundary. |
Accept | string Enum: "application/json" "application/msgpack" Preferred response content type |
{- "face_ids": [
- "426542d6-5509-4e5b-8a01-e2abd5c0a8c6"
]
}
link (or unlink) faces to a list
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 |
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. |
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 |
{- "action": "attach",
- "face_ids": [
- "557d54ec-29ad-4f3c-93b4-c9092ef12515"
], - "list_id": "string"
}
{- "error_code": 12012,
- "desc": "Bad/incomplete input data",
- "detail": "Bad query parameters 'account_id'",
}
Clean history of unlink attributes from lists. This history is required for correct update cash in matchers.
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. |
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. |
{- "error_code": 12012,
- "desc": "Bad/incomplete input data",
- "detail": "Bad query parameters 'time__lt'",
}
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
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 |
{- "error_code": 12024,
- "detail": "Bad/incomplete input data",
- "desc": "Unsupported media type",
}
Get sphinx documentation - Development Manual. After the request you will be redirected to the page /docs/dev/index.html
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. |
{- "error_code": 1,
- "detail": "internal server error",
- "desc": "internal server error",
}
Get service configuration. Passwords and tokens will be hidden in the response.
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 |
{- "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
}
}
Get list of service plugins
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. |
{- "plugins": [
- {
- "name": "foo",
- "running": 1
}
]
}
Get statistics of success and failed requests to the service in prometheus format.
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. |
# HELP request_count_total Counter of requests # TYPE request_count_total counter request_count_total{path="GET:/healthcheck",status_code="200"} 1.0
get health of service
include_luna_services | integer Default: 0 Enum: 0 1 Whether to perform healthchecks for dependent luna services. |
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. |
{- "execution_time": 0.123
}