Skip to main content
POST
Preview catalog matches

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"

Path Parameters

source_id
string
required

Body

application/json

"Ask it something" for a catalog: what find_listings would return for a question.

query
string | null

A question, as a caller would ask it.

Maximum string length: 500
arguments
Arguments · object | null

find_listings' arguments as the owner set them; skips the model.

agent_id
string | null

Fill the arguments with this agent's own model.

lang
string
default:en
Maximum string length: 8

Response

Successful Response

arguments
Arguments · object
required

The find_listings arguments used.

filters
Filters · object
required

The filters those arguments became.

found
boolean
required

Something matched.

exact
boolean
required

False when filters were relaxed to find something.

listings
any[]
required

The listings an agent would read out.

parameters
Parameters · object
required

The find_listings JSON Schema for this catalog.

total_ms
number
required

Total time in milliseconds.

available
integer | null

Available listings in the catalog.

available_matching
integer | null

Available listings that match.

prices_as_of
string | null

Prices are as of this time.

model
string | null

The model that picked the arguments, for a query.

model_ms
number | null

How long it took.