Access Documentation
FaceSearch
API Documentation
Get Face Count in Face Library
Get Face Count in Face Library

# Description

This API queries the total number of faces in the specified face library.

# Request URL:

https://api-sgp.yljz.com/finauth/search/group/get_size

Note: In production environments, please use HTTPS for communication. HTTP communication is considered insecure and poses security risks; therefore, it should not be used in production environments. Services using HTTP in production will not receive reliability guarantees.

# Calling Method

POST Note: Use form-data format for the request

# Request Parameters

Required? Field Type Description
Required sign String The client signature for calling this API. For how to generate the signature, see the "Authentication Guide" document.
Required sign_version String Signature algorithm version. Set to: hmac_sha1
Required group_id String User-defined face library identifier.

# Response Fields

Field Type Description
face_count Int Total number of face_token values in this library.
group_id String Face library identifier provided by the user.
request_id String A unique string to distinguish each request.
time_used Int Total time consumed by the request in milliseconds.
error
String Returned only when the request fails. See the error section below for details. Otherwise this field does not exist.

Response Example

Example: success response

{
    "request_id": "1769741218,8c912e9d-aed8-4180-9956-1e994ec4a135",
    "time_used": 60,
    "group_id": "YuanliStudent_01",
    "face_count": 1
}

Example: error response

{
    "request_id": "1769684828,e483ae63-913b-4e32-9068-3719cce59570",
    "time_used": 15,
    "error": "INVALID_GROUP_ID"
}