X-RequestID | string http://localhost:41101/api/match Request samples Content typeapplication/json {"tag": "string", "thumbnails": false, "images": [{"index": 0, "type": 1, "data": "string", "detectAll": false } ], } Response samples Content typeapplication/json {"code": 0, "detections": [{"faces": [{"faceIndex": 0, "rotationAngle": 0, "thumbnail": "string", "crop": "string" } ], "imageIndex": 0, "status": 0 } ], "results": [{"firstIndex": 0, "firstFaceIndex": 0, "first": 1, "secondIndex": 0, "secondFaceIndex": 0, "second": 1, "score": 0, "similarity": 0 } ], "metadata": { } } Match and Search in one request Request Body schema: application/jsontag | | | | groupIds | Array of strings <uuid> IDs of the groups in which the search is performed.
@@ -2234,11 +2235,11 @@ Clients
| | |
Local on-premise installation
http://localhost:41101/api/detect Request samples Content typeapplication/json {"tag": "string", "image": "string", "thumbnails": false } Response samples Content typeapplication/json {"code": 0, "results": {"detections": [{"crop": "string", "thumbnail": "string" } ], "detectorType": 0, "landmarksType": 0, "scenario": "OldMode", "timer": 0.8479356 } } Create person Request Body schema: application/jsonRequest Body schema: application/jsonname required | | | object A free-form object containing person's extended attributes.
| groups | Array of strings <uuid> Groups a person should be placed to. If no group is specified in request, a Default group is created and the person is placed to it.
|
ResponsesResponse Schema: application/jsonname | string Person name.
+ Response Schema: application/jsonname required | | | object A free-form object containing person's extended attributes.
| groups | Array of strings <uuid> Groups a person should be placed to. If no group is specified in request, a Default group is created and the person is placed to it.
| id | string <uuid> Person ID. The list of persons is sorted by decreasing ID value.
@@ -2247,12 +2248,13 @@ Clients
|
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Local on-premise installation
http://localhost:41101/api/persons Request samples Content typeapplication/json {"name": "string", "metadata": { }, } Response samples Content typeapplication/json Get person ResponsesResponse Schema: application/jsonname | string Person name.
+ Response Schema: application/jsonname required | | | object A free-form object containing person's extended attributes.
| groups | Array of strings <uuid> Groups a person should be placed to. If no group is specified in request, a Default group is created and the person is placed to it.
| id | string <uuid> Person ID. The list of persons is sorted by decreasing ID value.
@@ -2261,11 +2263,13 @@ Clients
|
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Local on-premise installation
http://localhost:41101/api/persons/{personId} Response samples Content typeapplication/json Update person header ParametersX-RequestID | string Request header label.
@@ -2277,27 +2281,31 @@ Clients
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Local on-premise installation
- http://localhost:41101/api/persons/{personId} Request samples Content typeapplication/json {"name": "string", "metadata": { }, } Response samples Content typeapplication/json {"statusCode": 0, "type": "string", "msg": "string" } Delete person path ParameterspersonId required | string <uuid> http://localhost:41101/api/persons/{personId} Request samples Content typeapplication/json {"name": "string", "metadata": { }, } Response samples Content typeapplication/json {"statusCode": 0, "type": "string", "msg": "string", "metadata": { } } Delete person ResponsesResponse Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Local on-premise installation
- http://localhost:41101/api/persons/{personId} Response samples Content typeapplication/json {"statusCode": 0, "type": "string", "msg": "string" } Get person images query Parameterspage required | integer Default: 1 The page number to get a list of persons or groups.
- | size required | integer Default: 1000 The page size with a list of persons or groups, items.
+ http://localhost:41101/api/persons/{personId} Response samples Content typeapplication/json {"statusCode": 0, "type": "string", "msg": "string", "metadata": { } } Get person images query Parameterspage | integer Default: 1 The page number to get a list of persons or groups.
+ | size | integer Default: 1000 The page size with a list of persons or groups, items.
|
ResponsesResponse Schema: application/jsonpage | integer Current page number.
@@ -2305,67 +2313,72 @@ Clients
| | |
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Local on-premise installation
http://localhost:41101/api/persons/{personId}/images Response samples Content typeapplication/json {"page": 1, "totalPages": 2, "items": [{"id": "string", "contentType": "string", "createdAt": "string", "updatedAt": "string", "path": "string", "url": "string", "metadata": { } } ] } Add person image Request Body schema: application/jsontag | | | | | object (OutputImageParams) Whether to process the uploaded image according to the indicated settings.
- | detectAll | boolean (detectAll) Default: false Whether to detect all faces in the image. If set to false, only the most central face is detected.
+ | required | | threshold | number <float> The similarity threshold.
| limit | integer The maximum number of results to be returned.
|
ResponsesResponse Schema: application/jsonid | string Response image ID. The list is sorted by decreasing ID value.
| contentType | string Original media type of the returned image.
| createdAt | string Returned image creation date.
- | updatedAt | string Returned image update date.
| path | | url | | | object A free-form object containing person's extended attributes.
|
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Local on-premise installation
- http://localhost:41101/api/persons/{personId}/images Request samples Content typeapplication/json {"tag": "string", "image": {"contentType": "string", "content": "string", "imageUrl": "string", "resizeOptions": {"width": 0, "height": 0, "quality": 100 } }, "detectAll": false, "threshold": 0, "limit": 0 } Response samples Content typeapplication/json {"id": "string", "contentType": "string", "createdAt": "string", "updatedAt": "string", "path": "string", "url": "string", "metadata": { } } Get person image by id path ParameterspersonId required | string <uuid> http://localhost:41101/api/persons/{personId}/images Request samples Content typeapplication/json {"tag": "string", "image": {"contentType": "string", "content": "string", "imageUrl": "string", "resizeOptions": {"width": 0, "height": 0, "quality": 100 } }, "threshold": 0, "limit": 0 } Response samples Content typeapplication/json {"id": "string", "contentType": "string", "createdAt": "string", "path": "string", "url": "string", "metadata": { } } Get person image by id path ParameterspersonId required | | imageId required | |
ResponsesResponse Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Local on-premise installation
- http://localhost:41101/api/persons/{personId}/images/{imageId} Response samples Content typeapplication/json {"statusCode": 0, "type": "string", "msg": "string" } Delete image of person path ParameterspersonId required | string <uuid> http://localhost:41101/api/persons/{personId}/images/{imageId} Response samples Content typeapplication/json {"statusCode": 0, "type": "string", "msg": "string", "metadata": { } } Delete image of person path ParameterspersonId required | | imageId required | |
ResponsesResponse Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Local on-premise installation
- http://localhost:41101/api/persons/{personId}/images/{imageId} Response samples Content typeapplication/json {"statusCode": 0, "type": "string", "msg": "string" } Get person groups query Parameterspage required | integer Default: 1 The page number to get a list of persons or groups.
- | size required | integer Default: 1000 The page size with a list of persons or groups, items.
+ http://localhost:41101/api/persons/{personId}/images/{imageId} Response samples Content typeapplication/json {"statusCode": 0, "type": "string", "msg": "string", "metadata": { } } Get person groups query Parameterspage | integer Default: 1 The page number to get a list of persons or groups.
+ | size | integer Default: 1000 The page size with a list of persons or groups, items.
|
ResponsesResponse Schema: application/json | Array of objects (Group) Array of Groups that are found during the search.
@@ -2374,14 +2387,16 @@ Clients
|
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Local on-premise installation
- http://localhost:41101/api/persons/{personId}/groups Response samples Content typeapplication/json {"page": 1, "totalPages": 2 } Get groups query Parameterspage required | integer Default: 1 The page number to get a list of persons or groups.
- | size required | integer Default: 1000 The page size with a list of persons or groups, items.
+ http://localhost:41101/api/persons/{personId}/groups Response samples Content typeapplication/json {"page": 1, "totalPages": 2 } Get groups query Parameterspage | integer Default: 1 The page number to get a list of persons or groups.
+ | size | integer Default: 1000 The page size with a list of persons or groups, items.
|
ResponsesResponse Schema: application/json | Array of objects (Group) Array of Groups that are found during the search.
@@ -2390,68 +2405,73 @@ Clients
|
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Local on-premise installation
- http://localhost:41101/api/groups Response samples Content typeapplication/json {"page": 1, "totalPages": 2 } Create group header ParametersX-RequestID | string http://localhost:41101/api/groups Response samples Content typeapplication/json {"page": 1, "totalPages": 2 } Create group Request Body schema: application/jsonRequest body for the group to create.
tag | | name | | | object A free-form object containing group's extended attributes.
+ | name required | | required | object A free-form object containing group's extended attributes.
|
ResponsesResponse Schema: application/jsontag | | name | string Group to create name.
+ Response Schema: application/jsonname | | | object A free-form object containing group's extended attributes.
| id | | createdAt | |
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Local on-premise installation
- http://localhost:41101/api/groups Request samples Content typeapplication/json {"tag": "string", "name": "string", "metadata": { } } Response samples Content typeapplication/json Get group path ParametersgroupId required | string <uuid> http://localhost:41101/api/groups Request samples Content typeapplication/json {"tag": "string", "name": "string", "metadata": { } } Response samples Content typeapplication/json Get group ResponsesResponse Schema: application/jsontag | | name | string Group to create name.
+ Response Schema: application/jsonname | | | object A free-form object containing group's extended attributes.
| id | | createdAt | |
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Local on-premise installation
- http://localhost:41101/api/groups/{groupId} Response samples Content typeapplication/json Update group path ParametersgroupId required | string <uuid> http://localhost:41101/api/groups/{groupId} Response samples Content typeapplication/json Update group Request Body schema: application/jsonRequest body for the group to update.
tag | | name | | | object A free-form object containing group's extended attributes.
+ | name required | | required | object A free-form object containing group's extended attributes.
|
ResponsesResponse Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Local on-premise installation
- http://localhost:41101/api/groups/{groupId} Request samples Content typeapplication/json {"tag": "string", "name": "string", "metadata": { } } Response samples Content typeapplication/json {"statusCode": 0, "type": "string", "msg": "string" } Delete group path ParametersgroupId required | string <uuid> http://localhost:41101/api/groups/{groupId} Request samples Content typeapplication/json {"tag": "string", "name": "string", "metadata": { } } Response samples Content typeapplication/json {"statusCode": 0, "type": "string", "msg": "string", "metadata": { } } Delete group ResponsesResponse Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Local on-premise installation
- http://localhost:41101/api/groups/{groupId} Response samples Content typeapplication/json {"statusCode": 0, "type": "string", "msg": "string" } Get group persons query Parameterspage required | integer Default: 1 The page number to get a list of persons or groups.
- | size required | integer Default: 1000 The page size with a list of persons or groups, items.
+ http://localhost:41101/api/groups/{groupId} Response samples Content typeapplication/json {"statusCode": 0, "type": "string", "msg": "string", "metadata": { } } Get group persons query Parameterspage | integer Default: 1 The page number to get a list of persons or groups.
+ | size | integer Default: 1000 The page size with a list of persons or groups, items.
|
ResponsesResponse Schema: application/json | Array of objects (Person) | page | integer Current page number.
@@ -2459,11 +2479,13 @@ Clients
|
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Local on-premise installation
http://localhost:41101/api/groups/{groupId}/persons Response samples Content typeapplication/json {"page": 1, "totalPages": 2 } Add/remove persons to group header ParametersX-RequestID | string Request header label.
@@ -2474,13 +2496,15 @@ Clients
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Response Schema: application/jsonstatusCode | | type | | msg | | msg | | | object A free-form object containing group's extended attributes.
|
Local on-premise installation
- http://localhost:41101/api/groups/{groupId}/persons Request samples Content typeapplication/json Response samples Content typeapplication/json {"statusCode": 0, "type": "string", "msg": "string" } Find person by image in groups header ParametersX-RequestID | string http://localhost:41101/api/groups/{groupId}/persons Request samples Content typeapplication/json Response samples Content typeapplication/json {"statusCode": 0, "type": "string", "msg": "string", "metadata": { } } Find person by image in groups Request Body schema: application/json | object If a person is not found, a new person entry is created using the descriptor calculated while searching.
| groupIds | Array of strings <uuid> IDs of the groups in which the search is performed.
| tag | string Session identificator.
@@ -2526,7 +2550,7 @@ Clients
Response Schema: application/jsonproperty name* additional property | |
Local on-premise installation
http://localhost:41101/api/readiness Response samples Content typeapplication/json
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|