Search Knowledge Base

POST

knowledge-bases

{kb_id}

curl --request POST \
  --url https://api.example.com/v1/knowledge-bases/{kb_id}/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "top_k": 5,
  "similarity_threshold": 0.7
}
'

{}

Headers

authorization

string | null

Path Parameters

kb_id

string<uuid>

required

Body

application/json

query

string

required

Required string length: 1 - 4000

top_k

integer

default:5

Required range: 1 <= x <= 50

similarity_threshold

number

default:0.7

Required range: 0 <= x <= 1

Response

Successful Response

The response is of type Response Search Knowledge Base V1 Knowledge Bases Kb Id Search Post · object.

Register ToolRegister a tool definition. Tools are stored as part of agent config. This endpoint validates the tool schema and returns it for confirmation. Actual attachment to an agent is done via PUT /v1/agents/:id.

⌘I

Search Knowledge Base

curl --request POST \
  --url https://api.example.com/v1/knowledge-bases/{kb_id}/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "top_k": 5,
  "similarity_threshold": 0.7
}
'

{}