Skip to main content
GET
/
health
curl -X GET "http://localhost:8080/health"
{
  "status": "ok",
  "dimension": null,
  "store_mode": null,
  "embedding_model": null,
  "items": 0,
  "max_items": 10000,
  "remaining": 10000
}
{
  "status": "ok",
  "dimension": 768,
  "store_mode": "text",
  "embedding_model": "BAAI/bge-base-en-v1.5",
  "items": 42,
  "max_items": 10000,
  "remaining": 9958
}

Overview

Returns server status, store mode, dimension, and how many items are stored versus the per-store cap (10,000).
curl -X GET "http://localhost:8080/health"
{
  "status": "ok",
  "dimension": null,
  "store_mode": null,
  "embedding_model": null,
  "items": 0,
  "max_items": 10000,
  "remaining": 10000
}
{
  "status": "ok",
  "dimension": 768,
  "store_mode": "text",
  "embedding_model": "BAAI/bge-base-en-v1.5",
  "items": 42,
  "max_items": 10000,
  "remaining": 9958
}

Response fields

FieldTypeDescription
statusstring"ok" when the server is up
dimensionnumber | nullLocked vector length after first upload
store_modestring | null"text" or "vector" after first upload
embedding_modelstring | nullSet for text stores (e.g. BGE model id)
itemsnumberCurrent item count in this store
max_itemsnumberStore item limit (10000)
remainingnumbermax_items - items