Skip to main content
PUT
/
kb
/
v1
/
knowledge-bases
/
{id}
Update Knowledge Base
curl --request PUT \
  --url https://api-prod.interactly.ai/kb/v1/knowledge-bases/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Knowledge Base Title",
  "description": "Knowledge Base Description",
  "retrain_frequency_minutes": 1440,
  "docs": [
    {
      "payload": {
        "urls_to_include": [
          {
            "url": "<string>",
            "subpaths_only": false,
            "recursive": false
          }
        ],
        "urls_to_exclude": [
          {
            "url": "<string>",
            "subpaths_only": false,
            "recursive": false
          }
        ]
      }
    }
  ],
  "files": [
    {
      "id": "5f7b1b1b1b1b1b1b1b1b1b1b"
    }
  ]
}
'
{
  "id": "5f7b1b1b1b1b1b1b1b1b1b1b",
  "title": "Knowledge Base Title",
  "description": "Knowledge Base Description",
  "status": "trained",
  "docs": [
    {
      "payload": {
        "urls_to_include": [
          {
            "url": "<string>",
            "subpaths_only": false,
            "recursive": false
          }
        ],
        "urls_to_exclude": [
          {
            "url": "<string>",
            "subpaths_only": false,
            "recursive": false
          }
        ]
      }
    }
  ],
  "files": [
    {
      "id": "5f7b1b1b1b1b1b1b1b1b1b1b",
      "name": "some_file.json",
      "type": "file",
      "createdAt": "2020-10-05T00:00:00.000Z",
      "updatedAt": "2020-10-05T00:00:00.000Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.interactly.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Path Parameters

id
string
required

Knowledge Base ID

Body

application/json
title
string

This is the title of the Knowledge Base.

Example:

"Knowledge Base Title"

description
string
Example:

"Knowledge Base Description"

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:

1440

docs
object[]

Here you can upload URLs

files
object[]

List of Files to be associated with the Knowledge Base.

Response

Successful response

id
string
Example:

"5f7b1b1b1b1b1b1b1b1b1b1b"

title
string

This is the title of the Knowledge Base.

Example:

"Knowledge Base Title"

description
string
Example:

"Knowledge Base Description"

status
enum<string>
Available options:
draft,
created,
queued,
training,
trained
Example:

"trained"

docs
object[]

Here you can upload URLs

files
object[]