Saltar al contenido principal
POST
/
faces
Add a new face to a collection
curl --request POST \
  --url https://face.argosidentity.com/faces \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "collectionId": "col_123456789",
  "userName": "John Doe",
  "faceImage": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQ..."
}
'
{
  "message": "Face added successfully",
  "faceId": "face_123456789",
  "metaFaceId": "meta_123456789",
  "option": {}
}
La sección “Agregar un nuevo rostro a una colección” permite a los usuarios cargar y almacenar fácilmente una nueva imagen facial dentro de una colección específica. Al utilizar esta funcionalidad, los usuarios pueden gestionar y organizar eficientemente sus datos de reconocimiento facial agregando nuevos rostros a su base de datos existente. Esta sección optimiza el proceso de expandir colecciones con datos faciales adicionales para mejorar la precisión y eficiencia en aplicaciones de reconocimiento facial.

​
Solicitud

​
Headers

​
x-api-key
string
requerido
La clave API utilizada para autenticación y control de acceso. Este parámetro de encabezado es requerido para autorización al agregar un nuevo rostro a una colección.

​
Parámetros del Body

​
collectionId
string
requerido
Identificador único de la colección donde se agregará el rostro.
​
userName
string
requerido
Nombre asociado al rostro que se está agregando a la colección.
​
faceImage
string
requerido
Representación en cadena codificada en Base64 de la imagen facial.

​
Respuesta

​
Respuesta Exitosa (200)

​
message
string
Un mensaje de éxito o error que indica el resultado del envío del rostro.
​
faceId
string
Identificador único para el envío del rostro.
​
metaFaceId
string
Identificador único correspondiente a los metadatos del envío del rostro.
​
option
object
Opciones adicionales y metadatos para el envío del rostro.

​
Respuestas de Error

​
Bad Request (400)

​
errorCode
number
Identifica el error específico para resolución de problemas:
  • 6010: CollectionId is required
  • 6011: WorkspaceId is required
  • 6012: Fail to add face
  • 6013: Cannot find collection info
  • 6014: This collection is unavailable
  • 6015: Failed to validate liveness of face
  • 6016: Image size is too large
  • 6017: Unsupported image format
​
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.
​
message
string
Describe brevemente el error:
  • API Key is required
  • Access Denied: API Key is unavailable

Autorizaciones

​
x-api-key
string
header
requerido

Cuerpo

application/json
​
collectionId
string
requerido

Unique identifier of the collection where the face will be added

Ejemplo:

"col_123456789"

​
userName
string
requerido

Name associated with the face being added to the collection

Ejemplo:

"John Doe"

​
faceImage
string
requerido

Base64-encoded string representation of the face image

Ejemplo:

"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQ..."

Respuesta

Face successfully added to collection

​
message
string

Success message

Ejemplo:

"Face added successfully"

​
faceId
string

Unique identifier for the face submission

Ejemplo:

"face_123456789"

​
metaFaceId
string

Unique identifier corresponding to the metadata of the face submission

Ejemplo:

"meta_123456789"

​
option
object

Additional options and metadata for the face submission