PUT
/
v2
/
knowledge-bases
/
{kb_id}
{
  "_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "document_language": "en",
  "document_count": 0,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "status": "processing"
}

Path Parameters

​
kb_id
string
required

Body

application/json

Data Transfer Object for updating an existing Knowledge Base.

​
name
string | null

New name for the knowledge base. Leave empty to keep the existing name.

​
description
string | null

New description for the knowledge base. Leave empty to keep the existing description.

​
document_language
string | null

New language for the documents in the knowledge base. Leave empty to keep the existing language.

Response

200
application/json
Successful Response

Response model for a Knowledge Base.

​
_id
string
required

Unique identifier of the knowledge base in MongoDB ObjectId format.

​
name
string
required

The name of the knowledge base.

​
created_at
string
required

UTC timestamp indicating when this knowledge base was created.

​
updated_at
string
required

UTC timestamp indicating when this knowledge base was last modified.

​
description
string | null

Detailed description of the knowledge base's purpose and contents.

​
document_language
string
default:en

The language of the documents in the knowledge base. This will be used to filter documents by language when adding to the knowledge base.

​
document_count
integer
default:0

Total number of documents currently stored in this knowledge base.

​
status
enum<string> | null

Status of the knowledge base. 'processing' means documents are being processed. 'completed' means all documents are processed and ready. 'failed' means there was an error in processing the documents.

Available options:
processing,
completed,
failed