Preview catalog matches
Shows which listings a catalog returns for a question, as an agent would find them. Send a query (the agent’s model picks the filters) or your own arguments. Nothing is recorded.
Scopes: knowledge:read
Authorizations
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
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.
2026-11-07 "2026-11-07"
Path Parameters
Body
"Ask it something" for a catalog: what find_listings would return for a question.
Response
Successful Response
The find_listings arguments used.
The filters those arguments became.
Something matched.
False when filters were relaxed to find something.
The listings an agent would read out.
The find_listings JSON Schema for this catalog.
Total time in milliseconds.
Available listings in the catalog.
Available listings that match.
Prices are as of this time.
The model that picked the arguments, for a query.
How long it took.