Sign in

v2

latestOpenAPI 3.1.02026-07-313981108.2 KB
Knowledge Bases

Update Knowledge Base

Update Knowledge Base

put/kb/v1/knowledge-bases/{id}

Path parameters

idstring required

Knowledge Base ID

Request body

titlestring

This is the title of the Knowledge Base.

descriptionstring
retrain_frequency_minutesinteger

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

Example request

{
  "title": "Knowledge Base Title",
  "description": "Knowledge Base Description",
  "retrain_frequency_minutes": 1440,
  "files": [
    {
      "id": "5f7b1b1b1b1b1b1b1b1b1b1b"
    }
  ]
}

Response

Successful response

idstring
titlestring

This is the title of the Knowledge Base.

descriptionstring
status'draft' | 'created' | 'queued' | 'training' | 'trained'

Example response

{
  "id": "5f7b1b1b1b1b1b1b1b1b1b1b",
  "title": "Knowledge Base Title",
  "description": "Knowledge Base Description",
  "status": "trained",
  "files": [
    {
      "id": "5f7b1b1b1b1b1b1b1b1b1b1b",
      "name": "some_file.json",
      "type": "file",
      "createdAt": "2020-10-05T00:00:00.000Z",
      "updatedAt": "2020-10-05T00:00:00.000Z"
    }
  ]
}