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": [
    {
      "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": "5f7b1b1b1b1b1b1b1b1b1b1b"
    }
  ]
}
'

{
  "id": "5f7b1b1b1b1b1b1b1b1b1b1b",
  "title": "Knowledge Base Title",
  "description": "Knowledge Base Description",
  "status": "trained",
  "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": "5f7b1b1b1b1b1b1b1b1b1b1b",
      "name": "some_file.json",
      "type": "file",
      "createdAt": "2020-10-05T00:00:00.000Z",
      "updatedAt": "2020-10-05T00:00:00.000Z"
    }
  ]
}

PUT

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": [
    {
      "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": "5f7b1b1b1b1b1b1b1b1b1b1b"
    }
  ]
}
'

{
  "id": "5f7b1b1b1b1b1b1b1b1b1b1b",
  "title": "Knowledge Base Title",
  "description": "Knowledge Base Description",
  "status": "trained",
  "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": "5f7b1b1b1b1b1b1b1b1b1b1b",
      "name": "some_file.json",
      "type": "file",
      "createdAt": "2020-10-05T00:00:00.000Z",
      "updatedAt": "2020-10-05T00:00:00.000Z"
    }
  ]
}

Authorizations

Authorization

string

header

required

Retrieve your API Key from Dashboard API Keys Section.

Path Parameters

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

Show child attributes

docs.type

enum<string>

Available options:

url

docs.payload

object

Here you can upload URLs

Show child attributes

docs.payload.urls_to_include

object[]

Show child attributes

docs.payload.urls_to_include.url

string<uri>

This is the URL of the Knowledge Base.

docs.payload.urls_to_include.subpaths_only

boolean

default:false

If subpaths_only is enabled, the crawler only processes URLs that are subpaths of the parent URL, ignoring links outside the specified path hierarchy.

docs.payload.urls_to_include.recursive

boolean

default:false

If recursive is enabled, the crawler recursively scrapes all URLs found on the page, including links to external domains.

docs.payload.urls_to_exclude

object[]

Show child attributes

docs.payload.urls_to_exclude.url

string<uri>

This is the URL of the Knowledge Base.

docs.payload.urls_to_exclude.subpaths_only

boolean

default:false

If subpaths_only is enabled, the crawler only processes URLs that are subpaths of the parent URL, ignoring links outside the specified path hierarchy.

docs.payload.urls_to_exclude.recursive

boolean

default:false

If recursive is enabled, the crawler recursively scrapes all URLs found on the page, including links to external domains.

files

object[]

List of Files to be associated with the Knowledge Base.

Show child attributes

files.id

string

Example:

"5f7b1b1b1b1b1b1b1b1b1b1b"

Response

Successful response

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

Show child attributes

docs.type

enum<string>

Available options:

url

docs.payload

object

Here you can upload URLs

Show child attributes

docs.payload.urls_to_include

object[]

Show child attributes

docs.payload.urls_to_include.url

string<uri>

This is the URL of the Knowledge Base.

docs.payload.urls_to_include.subpaths_only

boolean

default:false

If subpaths_only is enabled, the crawler only processes URLs that are subpaths of the parent URL, ignoring links outside the specified path hierarchy.

docs.payload.urls_to_include.recursive

boolean

default:false

If recursive is enabled, the crawler recursively scrapes all URLs found on the page, including links to external domains.

docs.payload.urls_to_exclude

object[]

Show child attributes

docs.payload.urls_to_exclude.url

string<uri>

This is the URL of the Knowledge Base.

docs.payload.urls_to_exclude.subpaths_only

boolean

default:false

If subpaths_only is enabled, the crawler only processes URLs that are subpaths of the parent URL, ignoring links outside the specified path hierarchy.

docs.payload.urls_to_exclude.recursive

boolean

default:false

If recursive is enabled, the crawler recursively scrapes all URLs found on the page, including links to external domains.

files

object[]

Show child attributes

files.id

string

Example:

"5f7b1b1b1b1b1b1b1b1b1b1b"

files.name

string

Example:

"some_file.json"

files.type

string

Example:

"file"

files.createdAt

string<date-time>

This is the ISO 8601 date-time string of when the record was created.

Example:

"2020-10-05T00:00:00.000Z"

files.updatedAt

string<date-time>

This is the ISO 8601 date-time string of when the record was last updated.

Example:

"2020-10-05T00:00:00.000Z"

Get Knowledge Base Delete Knowledge Base

⌘I

Getting Started

APIs

Campaigns

Update Knowledge Base

Authorizations

Path Parameters

Body

Response