Skip to content

Face Enroll API

Endpoint ini memungkinkan Anda untuk menambahkan gambar wajah baru ke database pribadi Anda.

Endpoint

POST /v1/face/enroll

Request Parameters

ParameterTypeRequiredDescription
database_namestringYesNama database tempat gambar akan disimpan
image_base64stringYesGambar wajah dalam format base64
metadataobjectNoMetadata tambahan dalam format JSON

Request Example

json
{
  "database_name": "default",
  "image_base64": "data:image/jpeg;base64,...",
  "metadata": {
    "name": "John Doe",
    "employee_id": "EMP123",
    "department": "IT"
  }
}

Metadata

Field metadata bersifat opsional dan fleksibel. Anda bebas memasukkan data apa saja selama format JSON valid. Contoh metadata yang umum digunakan:

  • name - Nama orang
  • employee_id - ID karyawan
  • department - Departemen
  • email - Alamat email
  • phone - Nomor telepon
  • notes - Catatan tambahan

Response

Success Response

json
{
  "message": "Image uploaded and database indexed successfully",
  "data": {
    "image_id": "DO46s5vDwayAFMVANMkM",
    "enroll_status": true
  }
}

Response Fields

FieldTypeDescription
messagestringStatus message
data.image_idstringID unik untuk gambar yang disimpan
data.enroll_statusbooleanStatus pendaftaran wajah

Automatic Indexing

Setiap kali gambar diunggah melalui endpoint /v1/face/enroll, database secara otomatis di-indexing untuk mempercepat pencarian di masa mendatang.

Error Responses

400 Bad Request

json
{
  "error": "Invalid image format",
  "message": "Image must be in base64 format"
}

401 Unauthorized

json
{
  "error": "Invalid API key",
  "message": "Please provide a valid API key"
}

422 Unprocessable Entity

json
{
  "error": "No face detected",
  "message": "Could not detect a face in the provided image"
}

Dokumentasi API Rivalistic