Skip to main content
POST
/
knowledge_bases
/
{knowledge_base_id}
/
search
Search a knowledge base by natural-language query
curl --request POST \
  --url https://api.example.com/knowledge_bases/{knowledge_base_id}/search \
  --header 'Content-Type: application/json' \
  --header 'x-user-id: <x-user-id>' \
  --data '
{
  "query": "<string>",
  "top_k": 5
}
'
{
  "results": [
    {
      "score": 123,
      "document_id": "<string>",
      "chunk": {
        "content": {
          "text": "<string>",
          "type": "text",
          "id": "<string>"
        },
        "source": "<string>",
        "chunk_index": 123,
        "total_chunks": 123,
        "metadata": {}
      }
    }
  ],
  "total": 123
}

Headers

x-user-id
string
required

Caller's user ID. Temporary header-based identity; will be replaced by JWT auth.

Path Parameters

knowledge_base_id
string
required

The knowledge base id.

Body

application/json

Request body for searching a knowledge base.

query
string
required

The natural-language search query.

top_k
integer
default:5

Maximum number of results to return.

Required range: 1 <= x <= 50

Response

Successful Response

Response body for a knowledge base search.

results
VectorSearchResult · object[]
required

Matched chunks ordered by descending similarity score.

total
integer
required

Total number of returned results.