Skip to main content
POST

Authorizations

Authorization
string
header
required

Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"

Body

multipart/form-data
knowledge_base_name
string
required

Name of the knowledge base. Must be less than 40 characters.

Example:

"Sample KB"

knowledge_base_texts
object[]

Texts to add to the knowledge base.

knowledge_base_files
file[]

Files to add to the knowledge base. Limit to 25 files, where each file is limited to 50MB.

knowledge_base_urls
string[]

URLs to be scraped and added to the knowledge base. Must be valid urls.

Example:
enable_auto_refresh
boolean

Whether to enable auto refresh for the knowledge base urls. If set to true, will retrieve the data from the specified url every 12 hours.

Example:

true

max_chunk_size
integer

Maximum number of characters per chunk when splitting knowledge base. Default is 2000. content. Immutable after creation.

Required range: 600 <= x <= 6000
Example:

2000

min_chunk_size
integer

Minimum number of characters per chunk. Chunks smaller than this will be merged with adjacent chunks. Must be less than max_chunk_size. Immutable after creation. Default is 400.

Required range: 200 <= x <= 2000
Example:

400

Response

Successfully created a new knowledge base.

knowledge_base_id
string
required

Unique id of the knowledge base.

Example:

"knowledge_base_a456426614174000"

knowledge_base_name
string
required

Name of the knowledge base. Must be less than 40 characters.

Example:

"Sample KB"

status
enum<string>
required

Status of the knowledge base. When it's created and being processed, it's "in_progress". When the processing is done, it's "complete". When there's an error in processing, it's "error". When it is during kb updating, it's "refreshing_in_progress".

Available options:
in_progress,
complete,
error,
refreshing_in_progress
Example:

"in_progress"

max_chunk_size
integer

Maximum number of characters per chunk when splitting knowledge base content.

Example:

2000

min_chunk_size
integer

Minimum number of characters per chunk. Chunks smaller than this are merged with adjacent chunks.

Example:

400

knowledge_base_sources
object[]

Sources of the knowledge base. Will be populated after the processing is done (when status is "complete").

enable_auto_refresh
boolean

Whether to enable auto refresh for the knowledge base urls. If set to true, will retrieve the data from the specified url every 12 hours.

Example:

true

last_refreshed_timestamp
integer

Last refreshed timestamp (milliseconds since epoch). Only applicable when enable_auto_refresh is true.

Example:

1703413636133