POST
/
create-knowledge-base

Authorizations

Authorization
string
headerrequired

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.

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.

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.

Response

201 - application/json
knowledge_base_id
string
required

Unique id of the knowledge base.

knowledge_base_name
string
required

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

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".

Available options:
in_progress,
complete,
error
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.

last_refreshed_timestamp
integer

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

Was this page helpful?

Delete Phone NumberGet Knowledge Base