Skip to main content
POST
/
search
curl -X POST "http://localhost:8080/search" \
  -H "Content-Type: application/json" \
  -d '{
    "query": [0.01, -0.02, "... match store dimension ..."],
    "top_k": 5
  }'
{
  "results": [
    {
      "id": "doc-1",
      "score": 0.894123,
      "label": "Close Match",
      "text": "Hello world"
    }
  ]
}

Overview

Search the local store using a numeric query vector. The query length must match the store dimension.
query
array
required
JSON array of floats (same length as store dimension).
top_k
number
default:"10"
Maximum results to return. Capped at 100.
threshold
number
default:"0"
Minimum score (0–1). Used when kiosk_mode is true.
kiosk_mode
boolean
default:"false"
When true, filters results below threshold.
curl -X POST "http://localhost:8080/search" \
  -H "Content-Type: application/json" \
  -d '{
    "query": [0.01, -0.02, "... match store dimension ..."],
    "top_k": 5
  }'
{
  "results": [
    {
      "id": "doc-1",
      "score": 0.894123,
      "label": "Close Match",
      "text": "Hello world"
    }
  ]
}

Result fields

FieldDescription
idMatched item id
scoreSimilarity score (0–1), rounded to 6 decimals
labelHuman-readable relevance label
textStored text, if any
The CLI and Python SDK can embed plain-text queries locally before calling this endpoint. See CLI: search and Python: search_text().