Large Face List - Get Face

Service:

Cognitive Services - Face

API Version:

1.0

Retrieve information about a persisted face (specified by persistedFaceId and its belonging largeFaceListId).

GET {Endpoint}/face/v1.0/largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).
largeFaceListId	path	True	string	Id referencing a particular large face list. Regex pattern: ^[a-z0-9-_]+$
persistedFaceId	path	True	string uuid	Id referencing a particular persistedFaceId of an existing face.

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string

Responses

Name	Type	Description
200 OK	PersistedFace	A successful call returns target persisted face's information (persistedFaceId and userData).
Other Status Codes	APIError	Error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Get persisted face example

Sample Request

HTTP

GET {Endpoint}/face/v1.0/largefacelists/abc/persistedfaces/015839fb-fbd9-4f79-ace9-7675fc2f1dd9

Sample Response

Status code:

200

{
  "persistedFaceId": "015839fb-fbd9-4f79-ace9-7675fc2f1dd9",
  "userData": "User-provided data attached to the face."
}

Definitions

Name	Description
APIError	Error information returned by the API
Error	Error body.
PersistedFace	PersonFace object.

APIError

Error information returned by the API

Name	Type	Description
error	Error	Error body.

Error

Error body.

Name	Type	Description
code	string
message	string

PersistedFace

PersonFace object.

Name	Type	Description
persistedFaceId	string	The persistedFaceId of the target face, which is persisted and will not expire. Different from faceId created by Face - Detect and will expire in at the time specified by faceIdTimeToLive after the detection call.
userData	string	User-provided data attached to the face. The size limit is 1KB.