Skip to main content
POST
/
knowledge-bases
/
{kb_id}
/
search
Search Knowledge Base
curl --request POST \
  --url https://api.example.com/knowledge-bases/{kb_id}/search

Path Parameters

ParameterTypeDescription
kb_idstringKnowledge base ID

Request Body

{
  "query": "How does billing work?",
  "limit": 5,
  "search_type": "hybrid",
  "vector_weight": 0.7,
  "keyword_weight": 0.3,
  "enable_mmr": true,
  "mmr_lambda": 0.5,
  "neighboring_chunks_count": 1
}
FieldTypeRequiredDefaultDescription
querystringyesSearch query
limitintnoservice defaultMaximum number of documents to return
search_typestringnoservice defaultsemantic, keyword, or hybrid
vector_weightfloatnoservice defaultHybrid vector contribution, from 0.0 to 1.0
keyword_weightfloatnoservice defaultHybrid keyword contribution, from 0.0 to 1.0
enable_mmrbooleannoservice defaultEnable Maximal Marginal Relevance diversity filtering
mmr_lambdafloatnoservice defaultMMR balance: 1.0 favors relevance, 0.0 favors diversity
neighboring_chunks_countintno0Adjacent chunks to include around each match

Response

{
  "documents": [
    {
      "id": "chunk_abc123",
      "content": "Billing is processed monthly on the...",
      "document_id": "doc_abc123",
      "source_file": "billing-guide.md",
      "chunk_index": 3,
      "metadata": {
        "score": 0.92
      }
    }
  ],
  "total_results": 1,
  "search_metadata": {
    "query": "How does billing work?",
    "search_type": "hybrid",
    "limit": 5,
    "similarity_threshold": null,
    "knowledge_bases_searched": ["Product Docs"]
  }
}