POST
Create Knowledge Base

Authorizations

X-API-Key
string
header
required

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

Headers

Idempotency-Key
string | null

Any unique string, such as a UUID. Send the same key again to get the first answer and not a second write. The API keeps an answer for 24 hours.

Path Parameters

brand_id
integer
required

Body

application/json
content
string
required
Required string length: 1 - 2000000
title
string
required
Required string length: 1 - 255
Example:

"Prices 2026"

type
string
required
Allowed value: "text"
chunk_tokens
integer
default:256

The tokens of a chunk. A smaller chunk gives a more exact search.

Required range: 64 <= x <= 2048

Response

Successful Response

chunk_tokens
integer
required
created_at
string<date-time>
required
id
integer
required
status
enum<string>
required

indexing: the platform reads it now. active: the check of the facts reads it.

Available options:
active,
indexing,
error,
cancelled
title
string
required
type
enum<string>
required
Available options:
text,
url,
file
updated_at
string<date-time>
required
version
integer
required

Each crawl again makes a new version.

crawled_pages
integer | null

The pages of the last crawl.

error
string | null
filenames
string[]
max_pages
integer | null
notify_emails
string[]
schedule
Schedule · object | null

When the platform crawls the site again, in UTC.

url
string | null
url_pattern
string | null