LUNA Backport 4 API (v.1.2.43)

Download OpenAPI specification:Download

VisionLabs Luna Backport 4 API. The API version is 5.

OpenAPI specification is the only valid document providing up-to-date information about the service API.

The specification can be used:

By documentation generation tools to visualize the API.
By code generation tools.

All the documents and code generated using this specification can include inaccuracies and should be carefully checked.

OpenAPI specification can be received using the "/docs/spec" resource. The "Accept" header should be set to "application/x-yaml".

version

get version

get versions of services

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
500

Content type

application/json

{"luna-api": {"api": 6,
"major": 3,
"minor": 1,
"patch": 2
},
"luna-faces": {"api": 2,
"major": 2,
"minor": 3,
"patch": 9
},
"luna-image-store-faces-samples": {"api": 1,
"major": 2,
"minor": 1,
"patch": 11
},
"luna-image-store-bodies-samples": {"api": 1,
"major": 2,
"minor": 1,
"patch": 11
},
"luna-image-store-images": {"api": 1,
"major": 2,
"minor": 1,
"patch": 11
},
"LUNA PLATFORM": {"major": 0,
"minor": 0,
"patch": 0
},
"luna-handlers": {"api": 1,
"major": 1,
"minor": 2,
"patch": 5
},
"luna-events": {"api": 1,
"major": 1,
"minor": 0,
"patch": 5
},
"luna-matcher-proxy": {"api": 1,
"major": 1,
"minor": 2,
"patch": 7
},
"luna-tasks": {"api": 1,
"major": 1,
"minor": 0,
"patch": 13
},
"luna-backport4": {"api": 5,
"major": 1,
"minor": 2,
"patch": 3
}
}

version options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

samples

detect faces

Detect faces in input images.

The request enables you to detect faces in input images, create samples, and estimate face properties.

You can specify thresholds for the head angles. If a head angle exceeds the specified threshold the image is not processed.

The estimated face properties are not saved to the Faces database. They are only returned in the response.

query Parameters

estimate_head_pose	integer (estimate_head_pose) Default: 0 Enum: 0 1 whether to estimate head pose in the image. Not supported with warped images (see `warped_image` parameter).
estimate_emotions	integer (estimate_emotions) Default: 0 Enum: 0 1 whether to estimate emotions in the image.
detect_landmarks68	integer (detect_landmarks68) Default: 0 Enum: 0 1 whether to detect basic 68-point facial landmarks in the image. Not supported with warped images (see `warped_image` parameter).
estimate_exif	integer (extract_exif) Default: 0 Enum: 0 1 whether to extract EXIF meta information from input JPEG images. Exact output will vary since there are no mandatory requirements for both authoring software and digital cameras how to write the data. This function will only parse the tags and output their names and values as they are. Please refer to JEITA CP-3451 EXIF specification for details.
estimate_quality	integer (estimate_quality) Default: 0 Enum: 0 1 whether to estimate input face image quality. Each of the following parameters is estimated: light, darkness, saturation and blur
estimate_gaze	integer (estimate_gaze) Default: 0 Enum: 0 1 whether to estimate eye gaze in the image. Not supported with warped images (see `warped_image` parameter).
estimate_eyes_attributes	integer (estimate_eyes_attributes) Default: 0 Enum: 0 1 whether to estimate eye attributes in the image. Not supported with warped images (see `warped_image` parameter).
estimate_mouth_attributes	integer (estimate_mouth_attributes) Default: 0 Enum: 0 1 whether to estimate mouth attributes in the image.
pitch_threshold	integer (pitch_threshold) [ 0 .. 180 ] Example: pitch_threshold=180 maximum deviation pitch angle from 0.
roll_threshold	integer (roll_threshold) [ 0 .. 180 ] Example: roll_threshold=180 maximum deviation roll angle from 0.
yaw_threshold	integer (yaw_threshold) [ 0 .. 180 ] Example: yaw_threshold=180 maximum deviation yaw angle from 0.
warped_image	integer (warped_image) Default: 0 Enum: 0 1 Whether input image is a sample or not.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).
Content-Type	string Enum: "image/jpeg" "image/png" "image/bmp" "image/x-portable-pixmap" "image/tiff" "multipart/form-data" "application/json" "image/x-jpeg-base64" "image/x-png-base64" "image/x-bmp-base64" "image/x-tiff-base64" "image/x-portable-pixmap-base64"

Request Body schema:
image/jpeg
image/jpeg
image/png
image/bmp
image/x-portable-pixmap
image/tiff
image/x-jpeg-base64
image/x-png-base64
image/x-bmp-base64
image/x-tiff-base64
image/x-portable-pixmap-base64
multipart/form-data
application/json

string <binary>

Responses

Request samples

Payload

Content type

No sample

Response samples

201
400
403
500

Content type

application/json

{"failed_images": {"error": {"desc": "Failed to decode image data",
"detail": "Failed to decodeImage image data.",
"error_code": 3001
},
"filename": "n.jpg"
},
"succeeded_images": [{"samples": [{"sample_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"detection": {"filter": {"is_filtered": true,
"filter_reason": [{"filter_name": "pitch_threshold",
"object_value": 67,
"threshold_value": 40
}
]
},
"attributes": {"mouth_attributes": {"occluded": 0,
"score": 0.999999165534973,
"smile": 0
},
"emotions": {"estimations": {"anger": 0.00894705578684807,
"disgust": 0.00000965219624049496,
"fear": 0.00121302821207792,
"happiness": 0.00129503419157118,
"neutral": 0.986027479171753,
"sadness": 0.00187553185969591,
"surprise": 0.000632198702078313
},
"predominant_emotion": "neutral"
},
"head_pose": {"pitch": 18.6827487945557,
"roll": -10.3542232513428,
"yaw": 15.4102487564087
},
"gaze": {"left_eye": {"pitch": 9.26744079589844,
"yaw": -19.4657287597656
},
"right_eye": {"pitch": 10.7074518203735,
"yaw": -14.6733160018921
}
}
},
"quality": {"light": 0.87,
"dark": 0.13,
"saturation": 0.93,
"blurriness": 0.2
},
"rect": {"height": 240,
"width": 209,
"x": 170,
"y": 198
},
"landmarks5": [[23,
72
],
[82,
71
],
[42,
114
],
[29,
140
],
[79,
138
]
],
"landmarks68": [[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
]
]
},
"url": "/0/samples/a16c8b6c-2818-4bae-9fd5-65acc8d4bb5c"
}
],
"filename": "claudia.jpg",
"exif": {"artist": "Photomaker Vadim",
"model": "Canon PX-200",
"software": "Adobe Photoshop CS5 Macintosh"
}
}
]
}

detector options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

save sample

Save sample to the storage.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).
Content-Type	string Enum: "image/jpeg" "image/png" "image/bmp" "image/tiff" "image/gif" "image/x-portable-pixmap"

Request Body schema:
image/jpeg
image/jpeg
image/png
image/bmp
image/tiff
image/gif
image/x-portable-pixmap

string <binary> (image_binary)

The sample has the following properties

its size is always 250x250 pixels
it's always in RGB color format
it always contains just a single face
the face is always centered and rotated so that imaginary line between the eyes is horizontal.

Responses

Response samples

201
400
403
500

Content type

application/json

{"sample_id": "b5d6fd45-fcca-453d-ac05-3e594054b813",
"url": "/5/samples/b5d6fd45-fcca-453d-ac05-3e594054b813"
}

samples options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get sample

Get sample by ID.

path Parameters

sample_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

404
500

Content type

application/json

{"error_code": 13003,
"desc": "Object not found",
"detail": "Image with id '7acc35cf-a3b2-4f87-8d8b-5496a2782d37' not found",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-13003"
}

check to exist a sample

Check existence of the sample with id=sample_id.

path Parameters

sample_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

remove sample

Remove sample by ID.

path Parameters

sample_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

403
404
500

Content type

application/json

{"error_code": 11036,
"desc": "Forbidden",
"detail": "Luna-Account-Id header is required for requests that change the state of system",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-11036"
}

sample options

get options for the resource

path Parameters

sample_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

attributes

extract attributes

Extract descriptors and basic attributes from samples. WARNING: Extracted attributes are temporary. Lifetime of temporary attributes can be configured using ATTRIBUTES_STORAGE_POLICY.MAX_TTL setting.

query Parameters

score_threshold	number (score_threshold) [ 0 .. 1 ] Default: 0 Example: score_threshold=0.74 descriptor quality score threshold. The higher the quality score for the image, the better the extraction results. All the attributes with a quality score below the threshold will be ignored (and not stored in the DB). The function will proceed as usual with all the remaining descriptors (if left). Consult VisionLabs about the recommended value of this parameter. Note! This parameter is not related to the image quality estimated in the detect faces request (`estimate_quality` request parameter).
extract_descriptor	integer (extract_descriptor) Default: 1 Enum: 0 1 Example: extract_descriptor=1 whether to extract face descriptor(s).
extract_basic_attributes	integer (extract_basic_attributes) Default: 0 Enum: 0 1 whether to extract basic attributes (gender, age, ethnicity).
aggregate_attributes	integer (aggregate_attributes) Default: 0 whether to aggregate face attributes. If the value is set to "0", a descriptor and basic attributes are extracted for each sample. If the value is set to "1", you can create an aggregated descriptor, receive aggregated basic attributes, or both. The behavior depends on the `extract_basic_attributes` and `extract_descriptor` parameters: If `extract_descriptor` is enabled, all the samples in the request will be used to create a single descriptor. An aggregated descriptor gives you more accurate results upon descriptors comparison. If `extract_basic_attributes` is enabled, all the samples in the request will be used to extract basic attributes. Age, gender and ethnicity values received from several samples are more precise. Make sure that all the samples in the request belong to the same person. If there are several faces in the input image, an error occurs.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).
Content-Type	string Value: "application/json" content type is application/json.

Request Body schema: application/json

Array ()

string <uuid4> (sample_id) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

sample ID.

Responses

Request samples

Payload

Content type

application/json

["b668c4a5-2191-476e-a261-3b4f9ce2e25e"
]

Response samples

201
400
403
404
500

Content type

application/json

[{"filter": {"is_filtered": true,
"filter_reason": [{"filter_name": "score_threshold",
"object_value": 0.75,
"threshold_value": 0.8
}
]
},
"attribute_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"basic_attributes": {"age": 0,
"gender": 0,
"ethnicities": {"estimations": {"african_american": 1.92238889737406e-12,
"asian": 0.954671621322632,
"caucasian": 0.045328326523304,
"indian": 7.65100649502415e-10
},
"predominant_ethnicity": "asian"
}
},
"score": 0,
"url": "/5/attributes/24d405ce-bc56-4bf7-98e1-bdc962b4cf34",
"samples": ["a3e8716f-70dc-42ad-8428-7a552e800a37"
]
}
]

extractor options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get attributes ids

Get temporary attributes IDs by filters. WARNING: Resource works with temporary attributes. Lifetime of temporary attributes can be configured using ATTRIBUTES_STORAGE_POLICY.MAX_TTL setting.

query Parameters

attribute_ids

required

string <list of uuid4>

Example: attribute_ids=8950722f-3fd4-4223-b48f-03f95f0e8dfb,346a5645-ec89-4806-820a-dbcb6e0dc38

list of comma-separated temporary attribute ids.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
400
500

Content type

application/json

{"attributes": [{"create_time": "2018-08-11T09:08:29.414Z",
"attribute_id": "dc8a97d4-e7f5-44f7-af1b-183b6ca8eef9"
},
{"create_time": "2018-05-11T09:08:29.414Z",
"attribute_id": "dc8a97e4-e7f5-44f7-af1b-183b6ca8eef9"
}
]
}

attributes options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get attributes count

Count temporary attributes. WARNING: Resource works with temporary attributes. Lifetime of temporary attributes can be configured using ATTRIBUTES_STORAGE_POLICY.MAX_TTL setting.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
500

Content type

text/plain

attributes count options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get basic attributes

Get basic attributes (gender, age, ethnicity) by temporary attribute ID. If temporary attribute with specified ID does not exist, try to get face attribute with face_id equal to attribute_id.

path Parameters

attribute_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

attribute id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
404
500

Content type

application/json

{"create_time": "2019-08-24T14:15:22Z",
"basic_attributes": {"gender": 0,
"age": 0,
"ethnicity": 1
}
}

check attributes existence

Check the existence of the attribute with the ID equal to attribute_id. If temporary attribute with specified ID does not exist, try to check face attribute existence with face_id equal to attribute_id.

path Parameters

attribute_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

attribute id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

500

Content type

application/json

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

delete attributes

Delete the attribute by its ID. If temporary attribute with specified ID does not exist, try to delete face attribute existence with face_id equal to attribute_id.

path Parameters

attribute_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

attribute id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

403
404
500

Content type

application/json

{"error_code": 11036,
"desc": "Forbidden",
"detail": "Luna-Account-Id header is required for requests that change the state of system",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-11036"
}

attribute options

get options for the resource

path Parameters

attribute_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

attribute id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get samples of attributes

Get samples associated with attribute ID. If temporary attribute with specified ID does not exist, try to get face samples with face_id equal to attribute_id.

path Parameters

attribute_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

attribute id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
404
500

Content type

application/json

[{"sample_id": "b5d6fd45-fcca-453d-ac05-3e594054b813",
"url": "/5/samples/b5d6fd45-fcca-453d-ac05-3e594054b813"
}
]

attribute samples options

get options for the resource

path Parameters

attribute_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

attribute id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

faces

create face

Create a new face.

The face can be attached to one or several lists.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).
Content-Type	string Value: "application/json" content type is application/json.

Request Body schema:
application/json
application/json
application/octet-stream

external_id	string (face_external_id) <= 36 characters Default: "" user-defined external ID for the face. External ID can be used to link several faces which belong to one person.
attribute_id	string <uuid4> (attribute_id) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... attribute ID. This ID links the descriptor, the face attributes, the sample, and the face received from a single image.
user_data	string (face_user_data) <= 128 characters Default: "" user data associated with face
avatar	string <uri-reference> (avatar) <= 256 characters Default: "" avatar is a visual representation of a face. The avatar can be used in the user interface. You can use a sample or an external image as the avatar.
lists	Array of strings <uuid4> (list_id) non-empty luna lists for linking face with them.
event_id	string <uuid4> Nullable ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... the event ID associated with the face creation.

Responses

Request samples

Payload

Content type

{"external_id": "2xQ2gprbMUePw1s9gw9fvA==",
"attribute_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"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"
]
}

Response samples

201
400
403
500

Content type

application/json

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

get faces

Get faces according to filters.

query Parameters

page	integer >= 1 Default: 1 a page number.
page_size	integer [ 1 .. 100 ] Default: 10 the number of items on page.
time__lt	string <date-time> (time) Example: time__lt=2018-08-11T09:11:41.674Z upper bound for object create_time.
time__gte	string <date-time> (time) Example: time__gte=2018-08-11T09:11:41.674Z lower included bound for object create_time.
face_ids	string <list of uuid4> Example: face_ids=8950722f-3fd4-4223-b48f-03f95f0e8dfb,346a5645-ec89-4806-820a-dbcb6e0dc38 list of comma-separated face ids.
external_id	string <= 36 characters external ID. When filtering by an external ID, you must specify the full `external_id` value.
user_data	string Example: user_data=user_data_text find all objects with `user_data` that is similar to this parameter. You can specify only part of the `user_data` value for this filter.
list_id	string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: list_id=557d54ec-29ad-4f3c-93b4-c9092ef12515 id of a list that contains faces.
targets	string Enum: "face_id" "attribute_id" "event_id" "user_data" "create_time" "external_id" "avatar" "lists" Example: targets=face_id,user_data Comma-separated list of face fields. If set, each face from result will contain only specified fields, otherwise, faces with all the fields will be returned.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
400
500

Content type

application/json

[{"face_id": "426542d6-5509-4e5b-8a01-e2abd5c0a8c6",
"external_id": "2xQ2gprbMUePw1s9gw9fvA==",
"attribute_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"user_data": "fox1991",
"create_time": "2018-08-11T09:11:41.674Z",
"lists": ["429b0e78-4616-426a-b57f-02baa72d638d",
"6d037c33-31ec-4d73-b3b3-ec80b09446c2"
],
"avatar": "https://st.kp.yandex.net/images/actor_iphone/iphone360_460188.jpg",
"event_id": "f9687459-986b-406d-9c1f-0d6289be5256"
}
]

faces options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get face count

Count faces according to the filters.

query Parameters

time__lt	string <date-time> (time) Example: time__lt=2018-08-11T09:11:41.674Z upper bound for object create_time.
time__gte	string <date-time> (time) Example: time__gte=2018-08-11T09:11:41.674Z lower included bound for object create_time.
face_ids	string <list of uuid4> Example: face_ids=8950722f-3fd4-4223-b48f-03f95f0e8dfb,346a5645-ec89-4806-820a-dbcb6e0dc38 list of comma-separated face ids.
external_id	string <= 36 characters external ID. When filtering by an external ID, you must specify the full `external_id` value.
user_data	string Example: user_data=user_data_text find all objects with `user_data` that is similar to this parameter. You can specify only part of the `user_data` value for this filter.
list_id	string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: list_id=557d54ec-29ad-4f3c-93b4-c9092ef12515 id of a list that contains faces.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
400
500

Content type

text/plain

faces count options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get face

Get face by ID.

path Parameters

face_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

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

query Parameters

targets

string

Enum: "face_id" "attribute_id" "event_id" "user_data" "create_time" "external_id" "avatar" "lists"

Example: targets=face_id,user_data

Comma-separated list of face fields. If set, each face from result will contain only specified fields, otherwise, faces with all the fields will be returned.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
400
404
500

Content type

application/json

{"face_id": "426542d6-5509-4e5b-8a01-e2abd5c0a8c6",
"external_id": "2xQ2gprbMUePw1s9gw9fvA==",
"attribute_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"user_data": "fox1991",
"create_time": "2018-08-11T09:11:41.674Z",
"lists": ["429b0e78-4616-426a-b57f-02baa72d638d",
"6d037c33-31ec-4d73-b3b3-ec80b09446c2"
],
"avatar": "https://st.kp.yandex.net/images/actor_iphone/iphone360_460188.jpg",
"event_id": "f9687459-986b-406d-9c1f-0d6289be5256"
}

patch face

Update face fields: user_data, external_id, attribute_id.

path Parameters

face_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

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

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).
Content-Type	string Value: "application/json" content type is application/json.

Request Body schema: application/json

external_id	string <= 36 characters user-defined external ID for the face.
attribute_id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... the attribute ID associated with the face.
event_id	string <uuid4> Nullable ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... the event ID associated with the face creation.
user_data	string <= 36 characters user-defined data for the face.
avatar	string <uri-reference> (avatar) <= 256 characters Default: "" avatar is a visual representation of a face. The avatar can be used in the user interface. You can use a sample or an external image as the avatar.

Responses

Request samples

Payload

Content type

application/json

{"external_id": "2xQ2gprbMUePw1s9gw9fvA==",
"attribute_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"user_data": "some_string",
"avatar": "https://upload.wikimedia.org/wikipedia/commons/7/7f/Emma_Watson_2013.jpg"
}

Response samples

400
403
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 ('userdata' was unexpected)'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12022"
}

remove face

Remove face by ID.

When a face is removed, attributes (descriptors and basic attributes) linked to the face are deleted. Samples linked to the face are not deleted.

path Parameters

face_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

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

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

403
404
500

Content type

application/json

{"error_code": 11036,
"desc": "Forbidden",
"detail": "Luna-Account-Id header is required for requests that change the state of system",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-11036"
}

check to exist a face

Check a face with id=face_id existence

path Parameters

face_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

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

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

500

Content type

application/json

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

face options

get options for the resource

path Parameters

face_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

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

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get face attributes

Get face attributes.

path Parameters

face_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

face id (face_id received in the "create face" request).

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
404
500

Content type

application/json

{"age": 20,
"gender": 1,
"ethnic_group": 2,
"create_time": "2018-08-11T09:08:29.414Z",
"attribute_id": "00000000-0000-4000-a000-000000000000"
}

face attributes options

get options for the resource

path Parameters

face_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

face id (face_id received in the "create face" request).

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get samples of faces

Get samples associated with the attribute ID linked to the face.

path Parameters

face_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

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

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
404
500

Content type

application/json

[{"sample_id": "b5d6fd45-fcca-453d-ac05-3e594054b813",
"url": "/5/samples/b5d6fd45-fcca-453d-ac05-3e594054b813"
}
]

face attributes samples options

get options for the resource

path Parameters

face_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

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

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

lists

create list

Create a new list.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).
Content-Type	string Value: "application/json" content type is application/json.

Request Body schema: application/json

user_data

required

string (list_user_data) <= 128 characters

Default: ""

user data associated with list

Responses

Request samples

Payload

Content type

application/json

{"user_data": "list of good persons"
}

Response samples

201
400
403
500

Content type

application/json

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

get lists

Get lists according to the filters.

query Parameters

create_time__lt	string <date-time> (time) Example: create_time__lt=2018-08-11T09:11:41.674Z upper bound for list create_time.
create_time__gte	string <date-time> (time) Example: create_time__gte=2018-08-11T09:11:41.674Z lower included bound for list create_time.
last_update_time__lt	string <date-time> (time) Example: last_update_time__lt=2018-08-11T09:11:41.674Z upper excluded bound for list last_update_time.
last_update_time__gte	string <date-time> (time) Example: last_update_time__gte=2018-08-11T09:11:41.674Z lower included bound for list last_update_time.
page	integer >= 1 Default: 1 a page number.
page_size	integer [ 1 .. 10000 ] 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 only part of the `user_data` value for this filter.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
400
500

Content type

application/json

[{"list_id": "c004aae2-f191-4a1a-9d2a-e5894f8cecbf",
"user_data": "good guys",
"create_time": "2018-08-11T09:11:41.674Z",
"last_update_time": "2018-08-11T09:11:41.674Z"
}
]

lists options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get list count

Count lists according to the filters.

query Parameters

user_data	string Example: user_data=user_data_text find all objects with `user_data` that is similar to this parameter. You can specify only part of the `user_data` value for this filter.
create_time__lt	string <date-time> (time) Example: create_time__lt=2018-08-11T09:11:41.674Z upper bound for list create_time.
create_time__gte	string <date-time> (time) Example: create_time__gte=2018-08-11T09:11:41.674Z lower included bound for list create_time.
last_update_time__lt	string <date-time> (time) Example: last_update_time__lt=2018-08-11T09:11:41.674Z upper excluded bound for list last_update_time.
last_update_time__gte	string <date-time> (time) Example: last_update_time__gte=2018-08-11T09:11:41.674Z lower included bound for list last_update_time.
list_ids	string <list of uuid4> list of comma-separated list ids.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
400
500

Content type

text/plain

lists count options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get list

Get list by id

path Parameters

list_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

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

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
404
500

Content type

application/json

{"list_id": "c004aae2-f191-4a1a-9d2a-e5894f8cecbf",
"user_data": "good guys",
"create_time": "2018-08-11T09:11:41.674Z",
"last_update_time": "2018-08-11T09:11:41.674Z"
}

check list existence

Check existence of the list with id=list_id.

path Parameters

list_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

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

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

500

Content type

application/json

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

update list

Update the user_data field of the list.

path Parameters

list_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

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

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Request Body schema: application/json

user_data

required

string (list_user_data) <= 128 characters

Default: ""

user data associated with list

Responses

Request samples

Payload

Content type

application/json

{"user_data": "list of good persons"
}

Response samples

400
403
404
500

Content type

application/json

{"error_code": 12022,
"desc": "Bad/incomplete input data",
"detail": "Failed to validate input json. Path: 'user_data',  message: 'user_data must be string'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-12012"
}

delete list

Delete list by id

path Parameters

list_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

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

query Parameters

with_faces

integer (int01)

Default: 0

Enum: 0 1

whether to delete list with all its' faces

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

403
404
500

Content type

application/json

{"error_code": 11036,
"desc": "Forbidden",
"detail": "Luna-Account-Id header is required for requests that change the state of system",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-11036"
}

list options

get options for the resource

path Parameters

list_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

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

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

attach/detach faces to the list

Attach or detach faces to the list.

path Parameters

list_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

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

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Request Body schema: application/json

action required	string Enum: "attach" "detach" expected action with list and faces.
face_ids required	Array of strings <uuid4> (face_id) non-empty faces to attach or detach to/from list.

Responses

Request samples

Payload

Content type

application/json

{"action": "attach",
"face_ids": ["b668c4a5-2191-476e-a261-3b4f9ce2e25e"
]
}

Response samples

400
403
404
500

Content type

application/json

Example

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

link options

get options for the resource

path Parameters

list_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

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

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

matcher

matching

Matcher API allows to submit tasks to a service that searches for faces similar to a given reference(s) by matching them.

Note! Descriptors must be extracted for reference(s) and candidate(s). Objects without descriptors cannot be matched.

The sources for references are events, attributes, face external IDs and faces. The sources for candidates are faces and lists.

If reference source is attribute and there is face with specified ID, matching will be executed against attributes of this face.

query Parameters

limit	integer [ 1 .. 100 ] Default: 3 count of match result for each reference by every candidate list.
targets	string Enum: "face_id" "attribute_id" "event_id" "user_data" "create_time" "external_id" "avatar" "lists" Example: targets=face_id,user_data Comma-separated list of candidate face fields to enrich the match result. If set, each face from result will contain specified fields besides the "face_id", otherwise, faces with all fields will be returned.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
Content-Type	string Value: "application/json"
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Request Body schema: application/json

required	object candidates for matching. You can specify the array of face IDs or the array of lists.
required	Array of Face_Reference (object) or Event_Reference (object) or Attribute_Reference (object) or External_Face_Reference (object) [ 1 .. 30 ] items references for matching. Each reference is matched with all the given candidates. You can specify one or several references of one or several types.

Responses

Request samples

Payload

Content type

application/json

{"candidates": {"type": "faces",
"ids": ["3772ea92-1198-40ea-8bae-fe912505a379",
"557d54ec-29ad-4f3c-93b4-c9092ef12515"
]
},
"references": [{"type": "attribute",
"id": "ef10bb7d-11b3-40b3-b4b0-c996a5f38150"
},
{"type": "attribute",
"id": "4aca35cf-a3b2-4f77-8d8b-5496a2782d37"
},
{"type": "face",
"id": "35229c93-85f8-44f3-ab30-3248d7051af9"
},
{"type": "face_external_id",
"id": "9dd0000-ff99093-1111"
},
{"type": "event",
"id": "5d56ff7a-be2b-497a-bb73-9099d1ba72ca"
}
]
}

Response samples

201
400
403
500

Content type

application/json

[{"succeeded_matches": [{"reference_id": "ef10bb7d-11b3-40b3-b4b0-c996a5f38150",
"matches": [{"candidates": [{"similarity": 0.9,
"face": {"face_id": "3772ea92-1198-40ea-8bae-fe912505a379",
"external_id": "2xQ2gprbMUePw1s9gw9fvA==",
"attribute_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"user_data": "some_string",
"create_time": "2019-11-11T09:11:41.674Z",
"avatar": "/5/samples/92ba3457-71b5-4744-b94a-2beb37db7d94"
}
}
],
"list_info": {"list_id": "8591e883-b5af-4ebd-a67c-5e9d4b0c474b",
"user_data": "customers"
}
}
]
},
{"reference_id": "4aca35cf-a3b2-4f77-8d8b-5496a2782d37",
"matches": [{"candidates": [{"similarity": 0.234,
"face": {"face_id": "3772ea92-1198-40ea-8bae-fe912505a379",
"external_id": "2xQ2gprbMUePw1s9gw9fvA==",
"attribute_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"user_data": "some_string",
"create_time": "2019-11-11T09:11:41.674Z",
"avatar": "/5/samples/92ba3457-71b5-4744-b94a-2beb37db7d94"
}
}
],
"list_info": {"list_id": "8591e883-b5af-4ebd-a67c-5e9d4b0c474b",
"user_data": "customers"
}
}
]
},
{"reference_id": "35229c93-85f8-44f3-ab30-3248d7051af9",
"matches": [{"candidates": [{"similarity": 0.1542,
"face": {"face_id": "3772ea92-1198-40ea-8bae-fe912505a379",
"external_id": "2xQ2gprbMUePw1s9gw9fvA==",
"attribute_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"user_data": "some_string",
"create_time": "2019-11-11T09:11:41.674Z",
"avatar": "/5/samples/92ba3457-71b5-4744-b94a-2beb37db7d94"
}
}
],
"list_info": {"list_id": "8591e883-b5af-4ebd-a67c-5e9d4b0c474b",
"user_data": "customers"
}
}
]
},
{"reference_id": "5d56ff7a-be2b-497a-bb73-9099d1ba72ca",
"matches": [{"candidates": [{"similarity": 0.032432,
"face": {"face_id": "3772ea92-1198-40ea-8bae-fe912505a379",
"external_id": "2xQ2gprbMUePw1s9gw9fvA==",
"attribute_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"user_data": "some_string",
"create_time": "2019-11-11T09:11:41.674Z",
"avatar": "/5/samples/92ba3457-71b5-4744-b94a-2beb37db7d94"
}
}
],
"list_info": {"list_id": "8591e883-b5af-4ebd-a67c-5e9d4b0c474b",
"user_data": "customers"
}
}
]
},
{"reference_id": "9dd0000-ff99093-1111",
"matches": [{"candidates": [{"similarity": 0.025235,
"face": {"face_id": "3772ea92-1198-40ea-8bae-fe912505a379",
"external_id": "2xQ2gprbMUePw1s9gw9fvA==",
"attribute_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"user_data": "some_string",
"create_time": "2019-11-11T09:11:41.674Z",
"avatar": "/5/samples/92ba3457-71b5-4744-b94a-2beb37db7d94"
}
}
],
"list_info": {"list_id": "8591e883-b5af-4ebd-a67c-5e9d4b0c474b",
"user_data": "customers"
}
}
],
"face_id": "c1c5c22f-4fc9-4fb5-be31-99c7d1c7030f"
}
],
"failed_matches": [{"reference_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
"error": {"error_code": 1,
"detail": "internal server error",
"desc": "internal server error",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-1"
}
}
]
}
]

matcher options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

handlers

create handler

Create a new handler.

The handler determines the list of rules (policies) for the processing of input images.

After the handler is created, you should use the "create events" request to process images using the handler.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).
Content-Type	string Value: "application/json" content type is application/json.

Request Body schema: application/json

description required	string <= 128 characters description of the handler. Use it to distinguish the handler from other created handlers and filter handlers using corresponding requests.
required	object (Policies) Nullable the set of rules, which determine input images processing.

Responses

Request samples

Payload

Content type

application/json

{"description": "Handler example",
"policies": {"detect_policy": {"estimate_head_pose": 0,
"estimate_emotions": 0,
"estimate_quality": 0,
"estimate_gaze": 0,
"estimate_eyes_attributes": 0,
"estimate_mouth_attributes": 0,
"detect_landmarks68": 0,
"extract_exif": 0,
"yaw_threshold": 180,
"roll_threshold": 180,
"pitch_threshold": 180
},
"multiface_policy": 0,
"extract_policy": {"extract_basic_attributes": 0,
"extract_descriptor": 1,
"score_threshold": 0.74
},
"match_policy": [{"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"filters": {"gender": 1,
"ethnicities": [4,
3
],
"age__lt": 30,
"age__gte": 22
},
"limit": 3
}
],
"create_face_policy": {"filters": {"gender": 1,
"ethnicities": [4,
3
],
"age__lt": 30,
"age__gte": 22,
"match": [{"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"similarity__lte": 0.9,
"similarity__gte": 0.78
}
]
},
"create_faces": 0,
"set_sample_as_avatar": 0
},
"link_to_lists_policy": [{"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"filters": {"gender": 1,
"ethnicities": [4,
3
],
"age__lt": 30,
"age__gte": 22,
"match": [{"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"similarity__lte": 0.9,
"similarity__gte": 0.78
}
]
}
}
]
}
}

Response samples

201
400
403
500

Content type

application/json

{"handler_id": "b5d6fd45-fcca-453d-ac05-3e594054b813",
"url": "/5/handlers/b5d6fd45-fcca-453d-ac05-3e594054b813"
}

get handlers

Get handlers by filters.

query Parameters

page	integer >= 1 Default: 1 a page number.
page_size	integer [ 1 .. 100 ] Default: 10 the number of items on page.
description	string find all the handlers with description similar to this parameter.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
400
500

Content type

application/json

[{"handler_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"description": "string",
"policies": {"detect_policy": {"estimate_head_pose": 0,
"estimate_emotions": 0,
"estimate_quality": 0,
"estimate_gaze": 0,
"estimate_eyes_attributes": 0,
"estimate_mouth_attributes": 0,
"detect_landmarks68": 0,
"extract_exif": 0,
"yaw_threshold": 180,
"roll_threshold": 180,
"pitch_threshold": 180
},
"multiface_policy": 0,
"extract_policy": {"extract_basic_attributes": 0,
"extract_descriptor": 1,
"score_threshold": 0.74
},
"match_policy": [{"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"filters": {"gender": 1,
"ethnicities": [4,
3
],
"age__lt": 30,
"age__gte": 22
},
"limit": 3
}
],
"create_face_policy": {"filters": {"gender": 1,
"ethnicities": [4,
3
],
"age__lt": 30,
"age__gte": 22,
"match": [{"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"similarity__lte": 0.9,
"similarity__gte": 0.78
}
]
},
"create_faces": 0,
"set_sample_as_avatar": 0
},
"link_to_lists_policy": [{"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"filters": {"gender": 1,
"ethnicities": [4,
3
],
"age__lt": 30,
"age__gte": 22,
"match": [{"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"similarity__lte": 0.9,
"similarity__gte": 0.78
}
]
}
}
]
},
"create_time": "2019-08-24T14:15:22Z",
"last_update_time": "2019-08-24T14:15:22Z"
}
]

handlers options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get handler count

Count handlers.

query Parameters

description

string

Find all the handlers with description similar to this parameter.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
400
500

Content type

application/json

{"handlers_count": 1
}

handler count options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get handler

Get handler by ID.

path Parameters

handler_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

handler id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
404
500

Content type

application/json

{"handler_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"description": "string",
"policies": {"detect_policy": {"estimate_head_pose": 0,
"estimate_emotions": 0,
"estimate_quality": 0,
"estimate_gaze": 0,
"estimate_eyes_attributes": 0,
"estimate_mouth_attributes": 0,
"detect_landmarks68": 0,
"extract_exif": 0,
"yaw_threshold": 180,
"roll_threshold": 180,
"pitch_threshold": 180
},
"multiface_policy": 0,
"extract_policy": {"extract_basic_attributes": 0,
"extract_descriptor": 1,
"score_threshold": 0.74
},
"match_policy": [{"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"filters": {"gender": 1,
"ethnicities": [4,
3
],
"age__lt": 30,
"age__gte": 22
},
"limit": 3
}
],
"create_face_policy": {"filters": {"gender": 1,
"ethnicities": [4,
3
],
"age__lt": 30,
"age__gte": 22,
"match": [{"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"similarity__lte": 0.9,
"similarity__gte": 0.78
}
]
},
"create_faces": 0,
"set_sample_as_avatar": 0
},
"link_to_lists_policy": [{"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"filters": {"gender": 1,
"ethnicities": [4,
3
],
"age__lt": 30,
"age__gte": 22,
"match": [{"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"similarity__lte": 0.9,
"similarity__gte": 0.78
}
]
}
}
]
},
"create_time": "2019-08-24T14:15:22Z",
"last_update_time": "2019-08-24T14:15:22Z"
}

update handler

Update a handler. You cannot update a part of a handler, so you must specify all the fields for your handler.

path Parameters

handler_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

handler id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).
Content-Type	string Value: "application/json" content type is application/json.

Request Body schema: application/json

description required	string <= 128 characters description of the handler. Use it to distinguish the handler from other created handlers and filter handlers using corresponding requests.
required	object (Policies) Nullable the set of rules, which determine input images processing.

Responses

Request samples

Payload

Content type

application/json

{"description": "Handler example",
"policies": {"detect_policy": {"estimate_head_pose": 0,
"estimate_emotions": 0,
"estimate_quality": 0,
"estimate_gaze": 0,
"estimate_eyes_attributes": 0,
"estimate_mouth_attributes": 0,
"detect_landmarks68": 0,
"extract_exif": 0,
"yaw_threshold": 180,
"roll_threshold": 180,
"pitch_threshold": 180
},
"multiface_policy": 0,
"extract_policy": {"extract_basic_attributes": 0,
"extract_descriptor": 1,
"score_threshold": 0.74
},
"match_policy": [{"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"filters": {"gender": 1,
"ethnicities": [4,
3
],
"age__lt": 30,
"age__gte": 22
},
"limit": 3
}
],
"create_face_policy": {"filters": {"gender": 1,
"ethnicities": [4,
3
],
"age__lt": 30,
"age__gte": 22,
"match": [{"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"similarity__lte": 0.9,
"similarity__gte": 0.78
}
]
},
"create_faces": 0,
"set_sample_as_avatar": 0
},
"link_to_lists_policy": [{"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"filters": {"gender": 1,
"ethnicities": [4,
3
],
"age__lt": 30,
"age__gte": 22,
"match": [{"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"similarity__lte": 0.9,
"similarity__gte": 0.78
}
]
}
}
]
}
}

Response samples

400
403
404
500

Content type

application/json

Example

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

check to exist a handler

Check a handler with id=handler_id existence.

path Parameters

handler_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

handler id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

500

Content type

application/json

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

remove handler

Remove handler by id.

path Parameters

handler_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

handler id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

403
404
500

Content type

application/json

{"error_code": 11036,
"desc": "Forbidden",
"detail": "Luna-Account-Id header is required for requests that change the state of system",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-11036"
}

handler options

get options for the resource

path Parameters

handler_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

handler id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

events

generate events

Process images using the specified handler and generate events.

If the Events service support is disabled on the server, events will not be saved to the database.

path Parameters

handler_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

handler id

query Parameters

external_id	string (event_external_id) <= 36 characters Default: "" Example: external_id=3.1415926 external ID for created faces.
user_data	string (event_user_data) <= 128 characters Default: "" Example: user_data=save event User data for created faces
warped_image	integer (warped_image) Default: 0 Enum: 0 1 Whether input image is a sample or not.
aggregate_attributes	integer (aggregate_attributes) Default: 0 whether to aggregate face attributes. If the value is set to "0", a descriptor and basic attributes are extracted for each sample. If the value is set to "1", you can create an aggregated descriptor, receive aggregated basic attributes, or both. The behavior depends on the `extract_basic_attributes` and `extract_descriptor` parameters: If `extract_descriptor` is enabled, all the samples in the request will be used to create a single descriptor. An aggregated descriptor gives you more accurate results upon descriptors comparison. If `extract_basic_attributes` is enabled, all the samples in the request will be used to extract basic attributes. Age, gender and ethnicity values received from several samples are more precise. Make sure that all the samples in the request belong to the same person. If there are several faces in the input image, an error occurs.
source	string (Source) <= 128 characters Example: source=Main_hall_camera Additional information, provided by user with event.
tags	Array of strings (tag) >= 0 items Example: tags=tag_1,tag_2 A comma-separated list of tags. Each event from result will contain all of the given tags. Each tag can be at most 36 characters.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).
Luna-Event-Time	string <date-time> (time) Examples: - time with timezone - utc time user defined event time. All events will be saved with this time as "create_time". Format of time is rfc3339. All other format is ignored.
Content-Type	string Enum: "image/jpeg" "image/png" "image/bmp" "image/x-portable-pixmap" "image/tiff" "multipart/form-data" "application/json" "image/x-jpeg-base64" "image/x-png-base64" "image/x-bmp-base64" "image/x-tiff-base64" "image/x-portable-pixmap-base64"

Request Body schema:
image/jpeg
image/jpeg
image/png
image/bmp
image/x-portable-pixmap
image/tiff
image/x-jpeg-base64
image/x-png-base64
image/x-bmp-base64
image/x-tiff-base64
image/x-portable-pixmap-base64
multipart/form-data
application/json

string <binary>

Responses

Request samples

Payload

Content type

No sample

Response samples

201
400
403
404
500

Content type

application/json

{"events": [{"samples": ["b668c4a5-2191-476e-a261-3b4f9ce2e25e"
],
"attributes": {"filter": {"is_filtered": true,
"filter_reason": [{"filter_name": "score_threshold",
"object_value": 0.75,
"threshold_value": 0.8
}
]
},
"attribute_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"basic_attributes": {"age": 0,
"gender": 0,
"ethnicities": {"estimations": {"african_american": 1.92238889737406e-12,
"asian": 0.954671621322632,
"caucasian": 0.045328326523304,
"indian": 7.65100649502415e-10
},
"predominant_ethnicity": "asian"
}
},
"score": 0,
"url": "/5/attributes/24d405ce-bc56-4bf7-98e1-bdc962b4cf34",
"samples": ["a3e8716f-70dc-42ad-8428-7a552e800a37"
]
},
"source": "Main_hall_camera",
"tags": ["tag1",
"tag2"
],
"external_id": "3.1415926",
"user_data": "save event",
"face": {"face_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"external_id": "3.1415926",
"event_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"user_data": "face of person",
"avatar": "string",
"lists": ["b668c4a5-2191-476e-a261-3b4f9ce2e25e"
],
"url": "string"
},
"event_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"url": "/0/events/24d405ce-bc56-4bf7-98e1-bdc962b4cf34",
"matches": [{"candidates": [{"similarity": 0,
"face": {"face_id": "426542d6-5509-4e5b-8a01-e2abd5c0a8c6",
"external_id": "2xQ2gprbMUePw1s9gw9fvA==",
"attribute_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"user_data": "fox1991",
"create_time": "2018-08-11T09:11:41.674Z",
"lists": ["429b0e78-4616-426a-b57f-02baa72d638d",
"6d037c33-31ec-4d73-b3b3-ec80b09446c2"
],
"avatar": "https://st.kp.yandex.net/images/actor_iphone/iphone360_460188.jpg",
"event_id": "f9687459-986b-406d-9c1f-0d6289be5256"
}
}
],
"list_info": {"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"user_data": "bad guys"
}
}
]
}
],
"detections": {"failed_images": {"error": {"desc": "Failed to decode image data",
"detail": "Failed to decodeImage image data.",
"error_code": 3001
},
"filename": "n.jpg"
},
"succeeded_images": [{"samples": [{"sample_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"detection": {"filter": {"is_filtered": true,
"filter_reason": [{"filter_name": "pitch_threshold",
"object_value": 67,
"threshold_value": 40
}
]
},
"attributes": {"mouth_attributes": {"occluded": 0,
"score": 0.999999165534973,
"smile": 0
},
"emotions": {"estimations": {"anger": 0.00894705578684807,
"disgust": 0.00000965219624049496,
"fear": 0.00121302821207792,
"happiness": 0.00129503419157118,
"neutral": 0.986027479171753,
"sadness": 0.00187553185969591,
"surprise": 0.000632198702078313
},
"predominant_emotion": "neutral"
},
"head_pose": {"pitch": 18.6827487945557,
"roll": -10.3542232513428,
"yaw": 15.4102487564087
},
"gaze": {"left_eye": {"pitch": 9.26744079589844,
"yaw": -19.4657287597656
},
"right_eye": {"pitch": 10.7074518203735,
"yaw": -14.6733160018921
}
}
},
"quality": {"light": 0.87,
"dark": 0.13,
"saturation": 0.93,
"blurriness": 0.2
},
"rect": {"height": 240,
"width": 209,
"x": 170,
"y": 198
},
"landmarks5": [[23,
72
],
[82,
71
],
[42,
114
],
[29,
140
],
[79,
138
]
],
"landmarks68": [[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
]
]
},
"url": "/0/samples/a16c8b6c-2818-4bae-9fd5-65acc8d4bb5c"
}
],
"filename": "claudia.jpg",
"exif": {"artist": "Photomaker Vadim",
"model": "Canon PX-200",
"software": "Adobe Photoshop CS5 Macintosh"
}
}
]
}
}

generate events options

get options for the resource

path Parameters

handler_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

handler id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get statistics on events.

Get event statistics by target(s) with applied filters.

Event fields and/or functions (count, min, etc.) can be set as targets for aggregation of events.

Grouping by frequency or grouping by time intervals is available.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).
Content-Type	string Value: "application/json" content type is application/json.

Request Body schema: application/json

Array of objects (targets) >= 0 items

Default: [{"column":"event_id","aggregator":"count"}]

You can specify one or several event fields and functions for them for data aggregation.

The table includes event fields and available functions for them:

Field	Function
	count	max	min	avg	group_by
event_id	+	-	-	-	+
external_id	+	-	-	-	+
handler_id	+	-	-	-	+
attribute_id	+	-	-	-	+
source	+	-	-	-	+
top_similar_face_id	+	-	-	-	+
top_similar_face_list	+	-	-	-	+
create_time	+	+	+	-	-
top_similar_face_similarity	+	+	+	+	-
face_id	+	-	-	-	+
gender	+	+	+	+	+
age	+	+	+	+	+
emotion	+	+	+	+	+
ethnic_group	+	+	+	+	+
user_data	+	-	-	-	+
tags	+	+	+	-	-

Note! There must be at least one function different from group_by in the targets, otherwise an error occurs.

Array of objects (filters) >= 0 items

specifies filters for events.

Operators available for each filter:

Filter	Operator
	like, nlike	in, nin	eq, neq	gt, gte, lt, lte
tags	+	-	-	-
source	-	+	+	-
user_data	-	+	+	-
event_id	-	+	+	+
external_id	-	+	+	+
handler_id	-	+	+	+
attribute_id	-	+	+	+
top_similar_face_id	-	+	+	+
top_similar_face_list	-	+	+	+
top_similar_face_similarity	-	-	-	+
face_id	-	+	+	+
gender	-	+	+	+
age	-	+	+	+
emotion	-	+	+	+
ethnic_group	-	+	+	+

Array of objects (periods) >= 0 items

specifies the period of event creation. All the events created during this period will be included in the statistics.

You can set the start and end of the period or only one of the bounds.

Note! You can specify only one period!

group_by

string (group_by)

enables you to group events by creation time according to one of two ways:

1) Grouping by time intervals - number and dimension

The parameter value	Description
`1m`	one minute
`2h`	two hours
`7d`	seven days
`5w`	five weeks
`3M`	three months
`10y`	ten years

2) The frequency grouping - one of the following

The parameter value	Description
`monthOfYear`	by month of year
`weekOfYear`	by week of year
`dayOfYear`	by day of year
`dayOfMonth`	by day of month
`dayOfWeek`	by day of week
`hourOfDay`	by hours of day
`minuteOfHour`	by minutes of hour

Responses

Request samples

Payload

Content type

application/json

{"targets": [{"column": "event_id",
"aggregator": "count"
},
{"column": "age",
"aggregator": "group_by"
},
{"column": "gender",
"aggregator": "group_by"
}
],
"filters": [{"column": "source",
"operator": "eq",
"value": "Main_hall_camera"
}
],
"period": [{"operator": "gt",
"value": "2020-02-04T00:00:00.000Z"
},
{"operator": "lt",
"value": "2020-02-06T00:00:00.000Z"
}
],
"group_by": "dayOfWeek"
}

Response samples

200
400
403
500

Content type

application/json

{"fields": ["Group by time: dayOfWeek",
"gender, aggregator 'group_by'",
"age, aggregator 'group_by'",
"event_id, aggregator 'count'"
],
"stats": [["Tuesday",
0,
22,
45
],
["Tuesday",
0,
27,
23
],
["Tuesday",
1,
27,
45
],
["Wednesday",
0,
25,
34
],
["Wednesday",
1,
33,
345
]
]
}

events statistics options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get events

Get events that satisfy filters. The target parameter determines field that will be shown for each event. If target is not set, the response will contain all the fields.

query Parameters

target

string

Enum: "create_time" "event_id" "handler_id" "external_id" "attribute_id" "source" "top_similar_face_id" "top_similar_face_list" "top_similar_face_similarity" "match_result" "extract_result" "face_id" "attach_result" "gender" "age" "emotion" "ethnic_group" "tags" "user_data"

Example: target=create_time,event_id,extract_result

Comma-separated list of event fields. If set, each event from result will contain only specified fields, otherwise, events with all fields will be returned.

create_time__gte

string <date-time> (time)

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

lower included bound for object create_time.

create_time__lt

string <date-time> (time)

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

upper bound for object create_time.

sources

string

Example: sources=cam1,cam2

Comma-separated list of sources. Each event from result will contain one of the given sources.

top_similar_face_list

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

ID of top similar face list.

top_similar_face_ids

Array of strings <uuid4> (uuid4)

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

Comma-separated list of top similar face ids. Each event from result will contain one of the given top similar face ids.

top_similar_face_similarity__gte

number

Example: top_similar_face_similarity__gte=0.5

Top similar face similarity lower included bound.

top_similar_face_similarity__lt

number

Example: top_similar_face_similarity__lt=0.5

Top similar face similarity upper excluded bound.

age__lt

integer

Example: age__lt=50

age upper excluded bound.

age__gte

integer

Example: age__gte=50

age lower included bound.

gender

integer

Enum: 0 1

Example: gender=1

Gender. 1 - male, 0 - female.

emotions

string <list of integer (1, 2, 3, 4, 5, 6, 7)>

Example: emotions=1,2,3

comma-separated list of predominant emotions. Each event from result will contain one of the given emotions.

emotions	value
anger	1
disgust	2
fear	3
happiness	4
neutral	5
sadness	6
surprise	7

ethnic_groups

string <list of integer (1, 2, 3, 4)>

Example: ethnic_groups=1,2

comma-separated list of dominant ethnic group. Each event from result will contain one of the given ethnic groups.

ethnicity	value
AfricanAmerican	1
Indian	2
Asian	3
Caucasian	4

face_ids

string <list of uuid4>

Example: face_ids=8950722f-3fd4-4223-b48f-03f95f0e8dfb,346a5645-ec89-4806-820a-dbcb6e0dc38

list of comma-separated face ids.

event_ids

string <list of uuid4.>

Example: event_ids=8950722f-3fd4-4223-b48f-03f95f0e8dfb,346a5645-ec89-4806-820a-dbcb6e0dc38

a list of comma-separated event ids.

handler_ids

string <list of uuid4.>

Example: handler_ids=8950722f-3fd4-4223-b48f-03f95f0e8dfb,346a5645-ec89-4806-820a-dbcb6e0dc38

a list of comma-separated handler ids.

external_ids

string <list of string.>

Example: external_ids=external_id_1,external_id_2

a 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 only part of the user_data value for this filter.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
400
403
500

Content type

application/json

{"total": 1,
"events": [{"create_time": "2018-08-11T09:11:41.674Z",
"event_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"handler_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"attribute_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"external_id": "3.1415926",
"source": "Main_hall_camera",
"top_similar_face_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"top_similar_face_list": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"top_similar_face_similarity": 0.7,
"match_result": [{"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"candidates": [{"similarity": 0,
"face": {"face_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"external_id": "3.1415926",
"attribute_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"user_data": "face of person",
"create_time": "2018-08-11T09:11:41.674Z"
}
}
]
}
],
"extract_result": [{"sample_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"detection": {"rect": {"x": 0,
"y": 0,
"width": 0,
"height": 0
}
}
}
],
"face_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"attach_result": ["b668c4a5-2191-476e-a261-3b4f9ce2e25e"
],
"gender": 0,
"age": 0,
"emotion": 1,
"ethnic_group": 1,
"tags": ["tag1",
"tag2"
],
"user_data": "save event"
}
]
}

events options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get event

Get event by ID.

path Parameters

event_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

event id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
403
404
500

Content type

application/json

{"create_time": "2018-08-11T09:11:41.674Z",
"event_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"handler_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"attribute_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"external_id": "3.1415926",
"source": "Main_hall_camera",
"top_similar_face_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"top_similar_face_list": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"top_similar_face_similarity": 0.7,
"match_result": [{"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"candidates": [{"similarity": 0,
"face": {"face_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"external_id": "3.1415926",
"attribute_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"user_data": "face of person",
"create_time": "2018-08-11T09:11:41.674Z"
}
}
]
}
],
"extract_result": [{"sample_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"detection": {"rect": {"x": 0,
"y": 0,
"width": 0,
"height": 0
}
}
}
],
"face_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"attach_result": ["b668c4a5-2191-476e-a261-3b4f9ce2e25e"
],
"gender": 0,
"age": 0,
"emotion": 1,
"ethnic_group": 1,
"tags": ["tag1",
"tag2"
],
"user_data": "save event"
}

check event existence

Check existence of the event with id=event_id.

path Parameters

event_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

event id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

500

Content type

application/json

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

event options

get options for the resource

path Parameters

event_id

required

string <uuid4> (uuid4) ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][...

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

event id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

task processing

clustering task

Create a new clustering task.

The Filters section enables to specify filters for faces or events clustering. Objects corresponding to all of the filters will be added to the cluster.

Available filters depend on the object type: events or faces.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Content-Type	string Value: "application/json" content type is application/json.
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Request Body schema: application/json

description	string provided user data for current task
required	object clustering task content

Responses

Request samples

Payload

Content type

application/json

{"description": "clustering faces",
"content": {"objects_type": "faces",
"filters": {"create_time__gte": "2018-08-11T09:11:41.674Z",
"create_time__lt": "2018-08-11T09:11:41.674Z",
"list_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515"
},
"threshold": 0.5
}
}

Response samples

202
400
403
500

Content type

application/json

{"task_id": 123
}

clustering options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

linker task

Create a new linker task.

The task enables you to attach faces to the specified list according to the filters.

You can use faces or events as objects for the task. When events are used, a new face is created for each of the events.

A list is required for the task processing:

If you specified a list, the Tasks service checks its existence. If there is no such a list, it will be created.
If you set new list creation using create_list = 1, a new list is created.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Content-Type	string Value: "application/json" content type is application/json.
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Request Body schema: application/json

description	string provided user data for current task
required	object (LinkerTaskContent) linker task content

Responses

Request samples

Payload

Content type

application/json

{"description": "linker task one",
"content": {"create_list": 1,
"list_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
"user_data": "list of good persons",
"objects_type": "faces",
"filters": {"create_time__gte": "2018-08-11T09:11:41.674Z",
"create_time__lt": "2018-08-11T09:11:41.674Z",
"list_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515"
}
}
}

Response samples

202
400
403
500

Content type

application/json

{"task_id": 123
}

linker options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

garbage collection task

Task is not available because all attributes is temporary and will be removed automatically.

header Parameters

Origin

string

Example: http://example.com

The Origin header indicates the origin of the cross-site access request

Responses

Response samples

400
403
500

Content type

application/json

{"error_code": 35000,
"desc": "Bad/incomplete input data",
"detail": "Attributes gc is not available",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-35000"
}

gc options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

reporter task

Create a report in csv format for a task.

Now the report is only created for clustering tasks.

The report contains additional information about clustering objects (faces or events). You can specify additional information that will be added to the report. The first and the second columns in the report always correspond to a cluster number and an object ID.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Content-Type	string Value: "application/json" content type is application/json.
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Request Body schema: application/json

description	string provided user data for the current task
required	object (ReporterTaskContent) reporter task content

Responses

Request samples

Payload

Content type

application/json

{"description": "report clustering events from cam1",
"content": {"filters": {"account_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"task_id": 146
},
"columns": ["create_time"
],
"csv_delimiter": "$",
"save_images": 1
}
}

Response samples

202
400
403
500

Content type

application/json

{"task_id": 123
}

reporter options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

cross-matching task

Create a new cross-matching task.

The cross-matching task enables you to compare references (faces or events) with candidates (faces or events) according to the specified filters.

All the references are matched with all the candidates.

You can limit the number of candidates returned in matching results and set the minimum acceptable similarity threshold.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Content-Type	string Value: "application/json" content type is application/json.
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Request Body schema: application/json

description	string provided user data for current task
required	object (CrossMatchTaskContent) cross match task content

Responses

Request samples

Payload

Content type

application/json

{"description": "matching visitors with the list of VIP customers",
"content": {"filters": {"reference_type": "events",
"candidate_type": "faces",
"reference_filters": {"gender": 1,
"sources": "Main_hall_camera"
},
"candidate_filters": {"create_time__gte": "2018-02-11T09:11:41.674Z",
"create_time__lt": "2020-02-12T09:11:41.674Z",
"list_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515"
}
},
"threshold": 0.5,
"limit": 3
}
}

Response samples

202
400
403
500

Content type

application/json

{"task_id": 123
}

cross match options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

ROC-curve calculating task

create a ROC-curve calculating task.

ROC (or Receiver Operating Characteristic) is a performance measurement for the classification problem at various threshold settings. The ROC-curve is plotted with TPR (True Positive Rate) against the FPR (False Positive Rate).

TPR is a true positive match pair count divided by a count of total expected positive match pairs, and FPR is a false positive match pair count divided by a count of total expected negative match pairs. Each point (FPR, TPR) of the ROC-cure corresponds to a certain similarity threshold.

Using ROC the model performance is determined by looking at the area under the ROC-curve (or AUC) and the ROC-curve and the secondary main diagonal intersection point, where type I and type II error rates are equal. The model performance also determined by getting into the top-N probability, i.e. probability of getting a positive match pair into the top-N for any match result group sorted by similarity.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Content-Type	string Value: "application/json" content type is application/json.
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Request Body schema: application/json

description	string provided user data for current task.
required	object (ROCTaskContent) roc task content.

Responses

Request samples

Payload

Content type

application/json

{"description": "matching famous people with customers",
"content": {"markup": [{"face_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"label": 12
},
{"face_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"label": 12
}
],
"filters": {"account_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e"
},
"threshold_hit_top": 0,
"limit": 100,
"key_FPRs": [0.000001,
0.001
]
}
}

Response samples

202
400
500

Content type

application/json

{"task_id": 123
}

roc options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

tasks

get tasks

Get tasks according to the filters.

query Parameters

page

integer >= 1

Default: 1

a page number.

page_size

integer [ 1 .. 100 ]

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.

end_time__lt

string <date-time> (time)

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

upper bound for object end_time.

end_time__gte

string <date-time> (time)

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

lower included bound for object end_time.

task_ids

string <comma-separate task ids> (taskIds)

Example: task_ids=1,2,3

comma-separated task ids

task_type

integer (taskType)

Enum: 0 1 2 3 4 6 7

Example: task_type=1

task type

task type	value
unknown	0
linker	1
clustering	2
report	3
garbage collection	4
cross match	6
ROC calculation	7

task_status

integer (taskStatus)

Enum: 0 1 2 3 4 5

Example: task_status=1

task status

task status	value
pending	0
in progress	1
cancelled	2
failed	3
collect results	4
done	5

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
400
403
500

Content type

application/json

{"tasks": [{"task_id": 123,
"create_time": "2018-08-11T09:11:41.674Z",
"end_time": "2018-08-11T09:11:41.674Z",
"last_update_time": "2018-08-11T09:11:41.674Z",
"task_type": 3,
"task_status": 1,
"result_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"count_task_parts_done": 10,
"count_task_parts_all": 100,
"content": {"objects_type": "faces",
"filters": {"create_time__gte": "2018-08-11T09:11:41.674Z",
"create_time__lt": "2018-08-11T09:11:41.674Z",
"list_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515"
},
"threshold": 0.5
},
"description": "task description"
}
]
}

tasks options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get tasks count

Count tasks according to the filters.

query Parameters

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.

end_time__lt

string <date-time> (time)

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

upper bound for object end_time.

end_time__gte

string <date-time> (time)

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

lower included bound for object end_time.

task_ids

string <comma-separate task ids> (taskIds)

Example: task_ids=1,2,3

comma-separated task ids

task_type

integer (taskType)

Enum: 0 1 2 3 4 6 7

Example: task_type=1

task type

task type	value
unknown	0
linker	1
clustering	2
report	3
garbage collection	4
cross match	6
ROC calculation	7

task_status

integer (taskStatus)

Enum: 0 1 2 3 4 5

Example: task_status=1

task status

task status	value
pending	0
in progress	1
cancelled	2
failed	3
collect results	4
done	5

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
400
403
500

Content type

application/json

{"count": 152
}

tasks count options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get task

Get task by ID.

path Parameters

task_id

required

integer >= 1

task id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"task_id": 123,
"create_time": "2018-08-11T09:11:41.674Z",
"end_time": "2018-08-11T09:11:41.674Z",
"last_update_time": "2018-08-11T09:11:41.674Z",
"task_type": 3,
"task_status": 1,
"result_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"count_task_parts_done": 10,
"count_task_parts_all": 100,
"content": {"objects_type": "faces",
"filters": {"create_time__gte": "2018-08-11T09:11:41.674Z",
"create_time__lt": "2018-08-11T09:11:41.674Z",
"list_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515"
},
"threshold": 0.5
},
"description": "task description"
}

cancel task

Cancel task by ID.

path Parameters

task_id

required

integer >= 1

task id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

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"
}

delete task

Delete a task and the task results by the task ID.

path Parameters

task_id

required

integer >= 1

task id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

400
404
500

Content type

application/json

Example

{"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"
}

task options

get options for the resource

path Parameters

task_id

required

integer >= 1

task id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get task result

Get task result by the task ID.

path Parameters

task_id

required

integer >= 1

task id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
404
500

Content type

Example

{"result": [{"attributes_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"samples": ["b668c4a5-2191-476e-a261-3b4f9ce2e25e"
]
}
],
"errors": [{"error_id": 10,
"task_id": 123,
"subtask_id": 5,
"error_code": 22004,
"description": "Faces not found",
"detail": "One or more faces not found, including face with id '8f4f0070-c464-460b-bf78-fac225df72e9'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-22004",
"additional_info": "8f4f0070-c464-460b-bf78-fac225df72e9",
"error_time": "2018-08-11T09:11:41.674Z"
}
]
}

task result options

get options for the resource

path Parameters

task_id

required

integer >= 1

task id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get subtasks

Get subtasks of a task by ID.

path Parameters

task_id

required

integer >= 1

task id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
400
403
500

Content type

application/json

[{"subtask_id": 5,
"task_id": 123,
"result_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"create_time": "2018-08-11T09:11:41.674Z",
"end_time": "2018-08-11T09:11:41.674Z",
"subtask_status": 2,
"content": "content"
}
]

subtasks options

get options for the resource

path Parameters

task_id

required

integer >= 1

task id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

task errors

get task errors

Get errors of a task by the task ID.

path Parameters

task_id

required

integer >= 1

task id

query Parameters

page	integer >= 1 Default: 1 a page number.
page_size	integer [ 1 .. 100 ] Default: 10 the number of items on page.

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
400
403
500

Content type

application/json

{"errors": [{"error_id": 10,
"task_id": 123,
"subtask_id": 5,
"error_code": 22004,
"description": "Faces not found",
"detail": "One or more faces not found, including face with id '8f4f0070-c464-460b-bf78-fac225df72e9'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-22004",
"additional_info": "8f4f0070-c464-460b-bf78-fac225df72e9",
"error_time": "2018-08-11T09:11:41.674Z"
}
]
}

task errors options

get options for the resource

path Parameters

task_id

required

integer >= 1

task id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get errors

Get errors according to the filters.

query Parameters

page

integer >= 1

Default: 1

a page number.

page_size

integer [ 1 .. 100 ]

Default: 10

the number of items on page.

task_ids

string <comma-separate task ids> (taskIds)

Example: task_ids=1,2,3

comma-separated task ids

error_code

integer (error_code)

Example: error_code=22004

error code

error_ids

string <comma-separate task ids> (errorIds) non-empty

Example: error_ids=4,5,6

comma-separated error ids

error_time__lt

string <date-time> (time)

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

upper bound for object error_time.

error_time__gte

string <date-time> (time)

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

lower included bound for object error_time.

task_type

integer (taskType)

Enum: 0 1 2 3 4 6 7

Example: task_type=1

task type

task type	value
unknown	0
linker	1
clustering	2
report	3
garbage collection	4
cross match	6
ROC calculation	7

status_code

integer (status_code) [ 400 .. 599 ]

Example: status_code=500

http status code

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
400
403
500

Content type

application/json

{"errors": [{"error_id": 10,
"task_id": 123,
"subtask_id": 5,
"error_code": 22004,
"description": "Faces not found",
"detail": "One or more faces not found, including face with id '8f4f0070-c464-460b-bf78-fac225df72e9'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-22004",
"additional_info": "8f4f0070-c464-460b-bf78-fac225df72e9",
"error_time": "2018-08-11T09:11:41.674Z"
}
]
}

errors options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get errors count

Count errors according to the filters.

query Parameters

error_time__lt

string <date-time> (time)

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

upper bound for object error_time.

error_time__gte

string <date-time> (time)

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

lower included bound for object error_time.

task_type

integer (taskType)

Enum: 0 1 2 3 4 6 7

Example: task_type=1

task type

task type	value
unknown	0
linker	1
clustering	2
report	3
garbage collection	4
cross match	6
ROC calculation	7

status_code

integer (status_code) [ 400 .. 599 ]

Example: status_code=500

http status code

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
400
403
500

Content type

application/json

{"count": 101
}

task errors count options

get options for the resource

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get error

Get error by ID.

path Parameters

error_id

required

integer >= 1

error id

query Parameters

error_id

integer (errorId)

Example: error_id=10

error id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).

Responses

Response samples

200
400
403
500

Content type

application/json

{"error_id": 10,
"task_id": 123,
"subtask_id": 5,
"error_code": 22004,
"description": "Faces not found",
"detail": "One or more faces not found, including face with id '8f4f0070-c464-460b-bf78-fac225df72e9'",
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-22004",
"additional_info": "8f4f0070-c464-460b-bf78-fac225df72e9",
"error_time": "2018-08-11T09:11:41.674Z"
}

error options

get options for the resource

path Parameters

error_id

required

integer >= 1

error id

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

liveness

predict liveness

Predict liveness probability in input images.

The response contains the probability that there is a real person in the image, and it is not a presentation attack.

Liveness V1 or Liveness V2 can be used for this resource. Liveness V2 does not use "meta" section of the request.

The incoming images should correspond the requirements of the utilized Liveness. See "Administrator’s manual" for details.

Liveness estimation is not supported for samples (warped images).

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Luna-Account-Id	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).
Content-Type	string Enum: "image/jpeg" "image/png" "image/bmp" "image/x-portable-pixmap" "image/tiff" "multipart/form-data" "application/json" "image/x-jpeg-base64" "image/x-png-base64" "image/x-bmp-base64" "image/x-tiff-base64" "image/x-portable-pixmap-base64"

Request Body schema:
multipart/form-data
multipart/form-data
application/json
image/jpeg
image/png
image/bmp
image/x-portable-pixmap
image/tiff
image/x-jpeg-base64
image/x-png-base64
image/x-bmp-base64
image/x-tiff-base64
image/x-portable-pixmap-base64

	object (LivenessMeta) Device information. This information can significantly decrease the overall error rate. The "meta" object is not mandatory. If you are not sure about any of the parameters, set "UNKNOWN" value or don't pass meta. The specified meta is applied to all the images within the request.
x_meta	object The JSON string with any additional information
required	Array of image_binary_for_multipart (string) or image_base64_for_multipart (string) (image_list_for_multipart) non-empty

Responses

Request samples

Payload

Content type

No sample

Response samples

200
400
403
500

Content type

application/json

{"failed_images": {"error": {"desc": "Failed to decode image data",
"detail": "File decoding error",
"error_code": 32010,
"link": "https://docs.visionlabs.ai/info/luna/troubleshooting/errors-description/code-32010"
},
"filename": "n.jpg"
},
"succeeded_images": [{"filename": "claudia.jpg",
"prediction": {"probability": 0.99,
"quality": 1
}
}
]
}

ws

ws handshake

Attention!

Subscription to events occurs via WebSocket. Messages sent by ws you can view in callback section. Connection supports autoping.

query Parameters

handler_ids

string <list of uuid4.>

Example: handler_ids=8950722f-3fd4-4223-b48f-03f95f0e8dfb,346a5645-ec89-4806-820a-dbcb6e0dc38

a list of comma-separated handler ids.

sources

string

Example: sources=cam1,cam2

Comma-separated list of sources. Each event from result will contain one of the given sources.

top_similar_face_lists

Array of strings <uuid4> (uuid4)

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

IDs of top similar face lists.

top_similar_face_similarity__gte

number

Example: top_similar_face_similarity__gte=0.5

Top similar face similarity lower included bound.

top_similar_face_similarity__lt

number

Example: top_similar_face_similarity__lt=0.5

Top similar face similarity upper excluded bound.

age__lt

integer

Example: age__lt=50

age upper excluded bound.

age__gte

integer

Example: age__gte=50

age lower included bound.

gender

integer

Enum: 0 1

Example: gender=1

Gender. 1 - male, 0 - female.

ethnic_groups

string <list of integer (1, 2, 3, 4)>

Example: ethnic_groups=1,2

comma-separated list of dominant ethnic group. Each event from result will contain one of the given ethnic groups.

ethnicity	value
AfricanAmerican	1
Indian	2
Asian	3
Caucasian	4

header Parameters

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
Luna-Account-Id required	string <uuid4> ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Example: 8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a account ID. Account is a limitation for all user actions (matching, removing, updating and other) on data which does not have corresponding account id. For example: it is impossible to attach a face with one account to a list with another account id. User can make a limited set of requests without this header (requests with methods GET, HEAD, OPTIONS, match requests and getting events statistics requests).
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

101
400
403
500

Content type

application/json

{"event": {"samples": ["b668c4a5-2191-476e-a261-3b4f9ce2e25e"
],
"attributes": {"attribute_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"basic_attributes": {"age": 0,
"gender": 0,
"ethnicities": {"estimations": {"african_american": 1.92238889737406e-12,
"asian": 0.954671621322632,
"caucasian": 0.045328326523304,
"indian": 7.65100649502415e-10
},
"predominant_ethnicity": "asian"
}
},
"score": 0,
"url": "/5/attributes/24d405ce-bc56-4bf7-98e1-bdc962b4cf34",
"samples": ["a3e8716f-70dc-42ad-8428-7a552e800a37"
]
},
"source": "3rd Avenue",
"user_data": "save event",
"tags": ["tag1",
"tag2"
],
"face": {"face_id": "426542d6-5509-4e5b-8a01-e2abd5c0a8c6",
"external_id": "2xQ2gprbMUePw1s9gw9fvA==",
"user_data": "fox1991",
"lists": ["429b0e78-4616-426a-b57f-02baa72d638d",
"6d037c33-31ec-4d73-b3b3-ec80b09446c2"
],
"avatar": "https://st.kp.yandex.net/images/actor_iphone/iphone360_460188.jpg",
"event_id": "f9687459-986b-406d-9c1f-0d6289be5256"
},
"event_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"url": "/0/events/24d405ce-bc56-4bf7-98e1-bdc962b4cf34",
"matches": [{"candidates": [{"similarity": 0,
"face": {"face_id": "426542d6-5509-4e5b-8a01-e2abd5c0a8c6",
"external_id": "2xQ2gprbMUePw1s9gw9fvA==",
"attribute_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"user_data": "fox1991",
"create_time": "2018-08-11T09:11:41.674Z",
"lists": ["429b0e78-4616-426a-b57f-02baa72d638d",
"6d037c33-31ec-4d73-b3b3-ec80b09446c2"
],
"avatar": "https://st.kp.yandex.net/images/actor_iphone/iphone360_460188.jpg",
"event_id": "f9687459-986b-406d-9c1f-0d6289be5256"
}
}
],
"list_info": {"list_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e",
"user_data": "bad guys"
}
}
],
"external_id": "3.1415926",
"detections": [{"filename": "penelope.jpeg",
"sample": {"url": "string",
"detection": {"attributes": {"mouth_attributes": {"occluded": 0,
"score": 0.999999165534973,
"smile": 0
},
"emotions": {"estimations": {"anger": 0.00894705578684807,
"disgust": 0.00000965219624049496,
"fear": 0.00121302821207792,
"happiness": 0.00129503419157118,
"neutral": 0.986027479171753,
"sadness": 0.00187553185969591,
"surprise": 0.000632198702078313
},
"predominant_emotion": "neutral"
},
"head_pose": {"pitch": 18.6827487945557,
"roll": -10.3542232513428,
"yaw": 15.4102487564087
},
"gaze": {"left_eye": {"pitch": 9.26744079589844,
"yaw": -19.4657287597656
},
"right_eye": {"pitch": 10.7074518203735,
"yaw": -14.6733160018921
}
}
},
"quality": {"light": 0.87,
"dark": 0.13,
"saturation": 0.93,
"blurriness": 0.2
},
"rect": {"height": 240,
"width": 209,
"x": 170,
"y": 198
},
"landmarks5": [[23,
72
],
[82,
71
],
[42,
114
],
[29,
140
],
[79,
138
]
],
"landmarks68": [[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
],
[12,
13
]
]
},
"sample_id": "b668c4a5-2191-476e-a261-3b4f9ce2e25e"
}
}
]
},
"handler_id": "557d54ec-29ad-4f3c-93b4-c9092ef12515",
"event-time": "2019-08-24T14:15:22Z",
"Luna-Request-id": "1536751345,8b8b5937-2e9c-4e8b-a7a7-5caf86621b5a"
}

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

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.
Accept	string (accept_docs_handler) Enum: "application/x-yaml" "text/html" acceptable type of recieving 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

Origin	string Example: http://example.com The Origin header indicates the origin of the cross-site access request
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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

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, the system will set it to the 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

{"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
}
}

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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

200
500
502

Content type

application/json

{"execution_time": 0.123
}

health options

get options for the resource

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, the system will set it to the default format ("timestamp,UUID"). It will be returned with response.

Responses

Response samples

500

Content type

application/json

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

get health (redirect)

get health of service (redirect)

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, the system will set it to the 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 Backport 4 API (v.1.2.43)

version

get version

header Parameters

Responses

Response samples

version options

header Parameters

Responses

Response samples

samples

detect faces

query Parameters

header Parameters

Request Body schema: image/jpegimage/jpegimage/pngimage/bmpimage/x-portable-pixmapimage/tiffimage/x-jpeg-base64image/x-png-base64image/x-bmp-base64image/x-tiff-base64image/x-portable-pixmap-base64multipart/form-dataapplication/json

Responses

Request samples

Response samples

detector options

header Parameters

Responses

Response samples

save sample

header Parameters

Request Body schema: image/jpegimage/jpegimage/pngimage/bmpimage/tiffimage/gifimage/x-portable-pixmap

Responses

Response samples

samples options

header Parameters

Responses

Response samples

get sample

path Parameters

header Parameters

Responses

Response samples

check to exist a sample

path Parameters

header Parameters

Responses

remove sample

path Parameters

header Parameters

Responses

Response samples

sample options

path Parameters

header Parameters

Responses

Response samples

attributes

extract attributes

query Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

extractor options

header Parameters

Responses

Response samples

get attributes ids

query Parameters

header Parameters

Responses

Response samples

attributes options

header Parameters

Responses

Response samples

get attributes count

header Parameters

Responses

Response samples

attributes count options

header Parameters

Responses

Response samples

get basic attributes

Request Body schema:
image/jpeg
image/jpeg
image/png
image/bmp
image/x-portable-pixmap
image/tiff
image/x-jpeg-base64
image/x-png-base64
image/x-bmp-base64
image/x-tiff-base64
image/x-portable-pixmap-base64
multipart/form-data
application/json

Request Body schema:
image/jpeg
image/jpeg
image/png
image/bmp
image/tiff
image/gif
image/x-portable-pixmap

Request Body schema:
application/json
application/json
application/octet-stream