API v1
Knowledge
Knowledge Search

Search In Knowledge Base

Searches using vector search in knowledge base

get/v1/knowledge/{kb_id}/search

Request

  • Base URL
    https://api.xpander.ai (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header x-api-key

Path parameters

kb_idstring required

Query parameters

search_querystring required

Query to search in the VDB

use_bubbleboolean nullable

Should use bubble search to return the result capped

bubble_sizeinteger nullable

Bubble size (padding + result + margin)

top_kinteger nullable

Top K Results

agent_idstring nullable

Search as this agent, the way its knowledge base tool does (the knowledge base must be attached to it and your key allowed to use it). Applies to a knowledge base on the Company Brain; otherwise ignored.

Response

Successful Response

contentstring required

The content of the document

scorenumber required

The search result score

Changes

No recorded changes to this operation across all 6 revisions of this API.