Skip to main content
GET
Search In Knowledge Base
Perform semantic search across documents in a knowledge base using vector similarity. Returns the most relevant document chunks based on your query.

Path Parameters

string
required
Unique identifier of the knowledge base to search (UUID format)

Query Parameters

string
required
The search query text to find relevant documents
integer
default:5
Number of results to return (default: 5, maximum: 50)

Response

Returns a flat array of search results, each containing:
string
The extracted text content from the matching document
number
Relevance score (float, higher indicates better match)

Example Request

Example Response

Notes

  • Search only returns results from documents with status: "completed"
  • Pending or failed documents are excluded from search results
  • Empty results indicate no matching content in the knowledge base
  • Returns 404 if the knowledge base is not found

Authorizations

x-api-key
string
header
required

API Key for authentication

Path Parameters

kb_id
string
required

Query Parameters

search_query
string
required

Query to search in the VDB

use_bubble
boolean | null
default:false

Should use bubble search to return the result capped

bubble_size
integer | null
default:1000

Bubble size (padding + result + margin)

top_k
integer | null
default:10

Top K Results

Response

Successful Response

content
string
required

The content of the document

score
number
required

The search result score