Skip to main content
POST
/
kb
/
v1
/
knowledge-bases
Create Knowledge Base
curl --request POST \
  --url https://api-prod.interactly.ai/kb/v1/knowledge-bases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "My Knowledge Base",
  "description": "<string>",
  "docs": [
    {
      "type": "url",
      "payload": {
        "urls_to_include": [
          {
            "url": "<string>",
            "subpaths_only": false,
            "recursive": false
          }
        ],
        "urls_to_exclude": [
          {
            "url": "<string>",
            "subpaths_only": false,
            "recursive": false
          }
        ]
      }
    }
  ],
  "files": [
    {
      "id": "<string>"
    }
  ],
  "retrain_frequency_minutes": 0
}
'

Authorizations

​
Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Body

application/json
​
title
string
required

A descriptive and human-readable name for the knowledge base

Example:

"My Knowledge Base"

​
description
string
​
docs
object[]

Here you can upload URLs

​
files
object[]
​
retrain_frequency_minutes
integer
default:0

Automatic retrain interval in minutes. Set retrain_frequency_minutes = 0 to disable automatic retraining. Allowed values: multiples of 60

Example:

0

Response

201

Knowledge Base created successfully