GET
Search Knowledge Bases

Authorizations

X-API-Key
string
header
required

An API key of your account, from Settings > API Keys. It starts with gnz-.

Path Parameters

brand_id
integer
required

Query Parameters

q
string
required

A question or words.

Required string length: 2 - 2000
knowledge_base_ids
integer[] | null

With no list, each knowledge base of the brand.

Minimum array length: 1
limit
integer
default:10
Required range: 1 <= x <= 50
min_similarity
number
default:0.6

From 0 to 1. A chunk with no relation to the query scores about 0.5, thus 0.6 keeps the related chunks and 0.8 the close ones.

Required range: 0 <= x <= 1

Response

Successful Response

data
Chunk · object[]
required
info
ListInfo · object
required