Nodeflux Central
Keyspace

Keyspace API

Endpoint untuk membuat, menghapus, dan menginspeksi keyspace pada FREMIS-N.


Keyspace

Manajemen namespace database. Gunakan keyspace untuk memisahkan data antar tenant, departemen, atau use-case dalam satu deployment FREMIS-N.

Membuat Keyspace Baru

Membuat namespace database baru untuk mengelompokkan enrollment wajah. Setiap keyspace adalah ruang terisolasi yang menyimpan vektor wajah unik. Gunakan endpoint ini untuk menginisialisasi keyspace sebelum melakukan enrollment.

POST
/v1/face/keyspace

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

text/plain

curl -X POST "https://fremis-n.example.com/v1/face/keyspace" \  -H "Content-Type: application/json" \  -d '{    "keyspace": "karyawan-jakarta",    "keyspace_id": 1  }'
{  "keyspace": "karyawan-jakarta"}
Empty
"Can't create new keyspace, keyspace limit is exceeded"
Empty
Empty
Empty

Mendapatkan Informasi Keyspace

Mengambil informasi detail keyspace tertentu, termasuk nama dan ID-nya. Endpoint ini berguna untuk verifikasi keberadaan keyspace atau retrieve ID numerik untuk operasi lain.

GET
/v1/face/keyspace/{keyspace_name}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

keyspace_name*string

Nama keyspace yang akan diakses

Response Body

application/json

curl -X GET "https://fremis-n.example.com/v1/face/keyspace/karyawan-jakarta"
{  "keyspace": "karyawan-jakarta",  "id": 123}
Empty
Empty
Empty
Empty

Menghapus Keyspace

Menghapus keyspace dan semua data enrollment wajah yang terdapat di dalamnya secara permanen. Operasi ini tidak dapat diurungkan. Pastikan keyspace tidak lagi digunakan sebelum menghapus.

DELETE
/v1/face/keyspace/{keyspace_name}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

keyspace_name*string

Nama keyspace yang akan diakses

Response Body

text/plain

curl -X DELETE "https://fremis-n.example.com/v1/face/keyspace/karyawan-jakarta"
"string"
Empty
Empty
Empty
Empty

Menghitung Jumlah Keyspace

Mengambil total jumlah keyspace yang tersedia di service FREMIS-N. Endpoint ini membantu monitoring kapasitas atau validasi limit keyspace dalam sistem.

GET
/v1/get-keyspaces-count

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Response Body

application/json

curl -X GET "https://fremis-n.example.com/v1/get-keyspaces-count"
{  "keyspaces_count": 15}
Empty
Empty
Empty
Empty

Mendapatkan Daftar Semua Keyspace

Mengambil array lengkap nama semua keyspace dalam sistem FREMIS-N. Berguna untuk enumerasi keyspace, validasi, atau keperluan UI yang menampilkan daftar keyspace yang tersedia.

GET
/v1/get-all-keyspaces

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Response Body

application/json

curl -X GET "https://fremis-n.example.com/v1/get-all-keyspaces"
{  "keyspaces": [    "karyawan-jakarta",    "vip-customers",    "watchlist-keamanan"  ]}
Empty
Empty
Empty
Empty

Menghitung Jumlah Vektor dalam Keyspace

Mengambil statistik enrollment dalam keyspace tertentu — total ID vektor dan total variasi vektor. Berguna untuk monitoring kapasitas keyspace atau analisis pertumbuhan enrollment.

GET
/v1/get-vector-count/{keyspace_name}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

keyspace_name*string

Nama keyspace yang akan dihitung vektornya

Response Body

application/json

curl -X GET "https://fremis-n.example.com/v1/get-vector-count/karyawan-jakarta"
{  "keyspace": "karyawan-jakarta",  "total_vector_ids": 500,  "total_vector_variations": 2500}
Empty
Empty
Empty
Empty

On this page