Saltar al contenido principal
GET
/
faces
Get list of faces in collection
curl --request GET \
  --url https://face.argosidentity.com/faces \
  --header 'x-api-key: <api-key>'
{
  "message": "Faces retrieved successfully",
  "result": [
    {
      "collection_id": "<string>",
      "face_id": "<string>",
      "user_name": "<string>",
      "create_time": "<string>",
      "meta_face_id": "<string>"
    }
  ],
  "totalCount": "<string>"
}
Este endpoint de API le permite recuperar una lista de todos los rostros contenidos dentro de una colección específica. Puede usar la paginación y la funcionalidad de búsqueda para gestionar eficientemente grandes colecciones de datos faciales.

​
Solicitud

​
Headers

​
x-api-key
string
La clave API utilizada para autenticación y control de acceso. Este parámetro de encabezado es requerido para autorización.

​
Parámetros de Consulta

​
collectionId
string
requerido
Identificador único de la colección donde se agregará el rostro.
​
page
string
requerido
Número de página para paginación. Devuelve 50 registros por iteración.
​
term
string
Recupera una lista de faceIds que contienen una cadena específica. (Debe tener al menos 5 caracteres de longitud)

​
Respuesta

​
Respuesta Exitosa (200)

​
message
string
Un mensaje de éxito o error que indica el resultado.
​
result
array
Array de objetos de rostros que contiene:collection_id: Identificador único de la colección de rostrosface_id: Identificador único del rostro en la colecciónuser_name: Nombre del usuario asociado al rostrocreate_time: Marca de tiempo de cuando se agregó el rostrometa_face_id: Un identificador de metadatos para el rostro
​
totalCount
string
Representa el número total de rostros encontrados que coinciden con los criterios de búsqueda. En este ejemplo, solo se encuentra un rostro, pero este valor podría ser mayor si se detectan más coincidencias.

​
Respuestas de Error

​
Bad Request (400)

​
errorCode
number
Identifica el error específico para resolución de problemas:
  • 6024: CollectionId is required
  • 6025: Term string is less than 5 characters long
  • 6026: Page is missing
  • 6027: Collection information does not exist
  • 6028: This collection is unavailable
  • 6029: Fail to get Face list
​
message
string
Describe brevemente el error. Consulte el código de error para más detalles.

​
Forbidden (403)

​
errorCode
number
Identifica el error específico para resolución de problemas:
  • 6039: API Key is required
  • 6040: Access Denied: API Key is unavailable
​
message
string
Describe brevemente el error. Consulte el código de error para más detalles.

Autorizaciones

​
x-api-key
string
header
requerido

Parámetros de consulta

​
collectionId
string
requerido

Unique identifier of the collection

​
page
string
requerido

Page number for pagination. Returns 50 pieces of data per iteration

​
term
string

Retrieves a list of faceIds containing a specific string. (Must be at least 5 characters long)

Respuesta

List of faces retrieved successfully

​
message
string

Success message

Ejemplo:

"Faces retrieved successfully"

​
result
object[]
​
totalCount
string

Total number of faces found that match the search criteria