POST
Create Knowledge Base From Files

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

Body

multipart/form-data
files
file[]
required

pdf, md, txt, docx, csv, xlsx or xlsm.

title
string
required
Required string length: 1 - 255
chunk_tokens
integer
default:256
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