HYVE Docs
DumpAPI Reference
GET/api/search

Search the vault using hybrid full-text + semantic search with composite ranking.

Query Parameters

ParameterTypeDefaultDescription
qstringRequired. Search query
source_typestringFilter by source type
categorystringFilter by category
limitnumber20Max results (max 100)

Example

curl
curl "http://localhost:3106/api/search?q=react+server+components&limit=10" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "items": [
    {
      "id": "uuid",
      "title": "Understanding RSC",
      "source_type": "article",
      "category": "Tech",
      "_score": 0.87,
      "...": "..."
    }
  ],
  "total": 15,
  "rag": [
    {
      "chunkId": "uuid",
      "documentId": "uuid",
      "title": "React Docs",
      "content": "Server Components allow...",
      "similarity": 0.82
    }
  ]
}

Fields

FieldDescription
itemsRanked search results with _score
totalTotal matches before ranking/limiting
ragAdditional semantic matches from RAG index (deduplicated)

Ranking

See Search feature docs for the full ranking formula and source weight table.

Status Codes

CodeDescription
200Success
400Missing q parameter
401Unauthorized
500Server error

On this page