Skip to main content
POST
Search knowledge

Authorizations

Authorization
string
header
required

An API key from Settings → API keys, sent as Authorization: Bearer kb_live_…. A workspace key starts kb_; a personal key starts kbp_ and acts as its owner.

Headers

Kallabot-Version
enum<string>

The API version to answer as, a date (YYYY-MM-DD). Leave it out for the current version (2026-11-07). An unknown version is refused with 400 unsupported_api_version.

Available options:
2026-11-07
Example:

"2026-11-07"

Body

application/json
query
string
required
Required string length: 1 - 500
agent_id
string | null

Search what this agent attaches (its draft).

source_ids
string[] | null

Or exactly these sources.

Maximum array length: 40
channel
enum<string>
default:playground
Available options:
playground,
phone,
web,
whatsapp,
instagram,
messenger,
web_chat
top_k
integer
default:3
Required range: 1 <= x <= 10
lang
string
default:en
Maximum string length: 8

Response

Successful Response

passages
KnowledgePassage · object[]
required

The passages an agent would answer from.

listings
any[]
required

Always empty here; use the listings preview for catalogs.

catalog_ids
string[]
required

Catalogs among the sources searched.

filters
Filters · object
required

Filters applied.

latency_ms
number
required

Search time in milliseconds.

total_ms
number
required

Total time in milliseconds.

path
string | null

How the passages were found.

matched
any

What matched.

relaxed
boolean | null

The search was widened to find something.

price_as_of
string | null

Prices are as of this time.

embed_ms
number | null

Embedding time in milliseconds.

model
string | null

The embedding model.

reference
any

A reference for support.