Knowledge Base (New)
Create Knowledge Base
POST /api/knowledge-bases/
Request Body
Parameters
embeddingModel
string (uuid)
Yes
rerankerModel
string (uuid)
Yes
name
string
Yes
description
string
No
numberOfRetrievedChunks
integer
No
Number of retrieved reference chunks, default is 12, minimum is 1
sentenceWindowSize
integer
No
RAG augmented sentence window size, default is 2, minimum is 0
enableHyde
boolean
No
Enable HyDE, default is False
similarityCutoff
number (double)
No
Similarity cutoff, default is 0.0, range is 0.0-1.0
enableRerank
boolean
No
Enable reranking, default is True
chatbots
array[IdName]
No
groups
array[IdName]
No
Request Structure Example
{
"embeddingModel": string (uuid)
"rerankerModel": string (uuid)
"name": string
"description"?: string // Optional
"numberOfRetrievedChunks"?: integer // Number of retrieved chunks, default is 12, minimum is 1 (Optional)
"sentenceWindowSize"?: integer // RAG augmented sentence window size, default is 2, minimum is 0 (Optional)
"enableHyde"?: boolean // Enable HyDE, default is False (Optional)
"similarityCutoff"?: number (double) // Similarity cutoff, default is 0.0, range is 0.0-1.0 (Optional)
"enableRerank"?: boolean // Whether to enable reranking, default is True (Optional)
"chatbots"?: [ // Optional
{
"id": string (uuid)
}
]
"groups"?: [ // Optional
{
"id": string (uuid)
}
]
}Request Example Value
Code Examples
Response Body
Status Code: 201
Response Schema Example
Response Example Value
List all knowledge bases
GET /api/knowledge-bases/
Parameters
embeddingModel
❌
string
page
❌
integer
A page number within the paginated result set.
pageSize
❌
integer
Number of results to return per page.
query
❌
string
rerankerModel
❌
string
Code Examples
Response Body
Status Code: 200
Response Schema Example
Response Example Value
Get Specific Knowledge Base Details
GET /api/knowledge-bases/{id}/
Parameters
id
✅
string
A UUID string identifying this Knowledge Base.
Code Example
Response Body
Status Code: 200
Response Schema Example
Response Example Value
Update Knowledge Base
PUT /api/knowledge-bases/{id}/
Parameters
id
✅
string
A UUID string identifying this Knowledge Base.
Request Body
Request Parameters
user
string (uuid)
No
organization
string (uuid)
No
embeddingModel
string (uuid)
Yes
rerankerModel
string (uuid)
Yes
name
string
Yes
description
string
No
numberOfRetrievedChunks
integer
No
Number of retrieved reference chunks, default is 12, minimum is 1
sentenceWindowSize
integer
No
RAG augmented sentence window size, default is 2, minimum is 0
enableHyde
boolean
No
Enable HyDE, default is False
similarityCutoff
number (double)
No
Similarity cutoff, default is 0.0, range is 0.0-1.0
enableRerank
boolean
No
Whether to enable reranking, default is True
chatbots
array[IdName]
No
groups
array[IdName]
No
List of groups that can access the knowledge base
Request Structure Example
Request Example Value
Code Examples
Response Body
Status Code: 200
Response Schema Example
Response Example Value
Partially Update a Knowledge Base
PATCH /api/knowledge-bases/{id}/
Parameters
id
✅
string
A UUID string identifying this Knowledge Base.
Request Body
Request Parameters
user
string (uuid)
No
organization
string (uuid)
No
embeddingModel
string (uuid)
No
rerankerModel
string (uuid)
No
name
string
No
description
string
No
numberOfRetrievedChunks
integer
No
Number of retrieved reference chunks, default is 12, minimum is 1
sentenceWindowSize
integer
No
RAG augmented sentence window size, default is 2, minimum is 0
enableHyde
boolean
No
Enable HyDE, default is False
similarityCutoff
number (double)
No
Similarity cutoff threshold, default is 0.0, range is 0.0-1.0
enableRerank
boolean
No
Whether to enable reranking, default is True
chatbots
array[IdName]
No
groups
array[IdName]
No
List of groups that can access the knowledge base
Request Schema Example
Request Example Value
Code Examples
Response Body
Status Code: 200
Response Schema Example
Response Example Value
Delete Knowledge Base
DELETE /api/knowledge-bases/{id}/
Parameters
id
✅
string
A UUID string identifying this Knowledge Base.
Code Examples
Response
204
No response body
Create a New Label
POST /api/knowledge-bases/{knowledgeBasePk}/labels/
Parameters
knowledgeBasePk
✅
string
Request Body
Request Parameters
name
string
Yes
Request Structure Example
Request Example Value
Code Examples
Response Body
Status Code: 201
Response Schema Example
Response Example Value
List labels in a knowledge base
GET /api/knowledge-bases/{knowledgeBasePk}/labels/
Parameters
knowledgeBasePk
✅
string
page
❌
integer
A page number within the paginated result set.
pageSize
❌
integer
Number of results to return per page.
Code Examples
Response Body
Status Code: 200
Response Schema Example
Response Example Value
Get Specific Label Details
GET /api/knowledge-bases/{knowledgeBasePk}/labels/{id}/
Parameters
id
✅
string
A UUID string identifying this knowledge base label.
knowledgeBasePk
✅
string
Code Examples
Response Body
Status Code: 200
Response Schema Example
Example Response Value
Update Label
PUT /api/knowledge-bases/{knowledgeBasePk}/labels/{id}/
Parameters
id
✅
string
A UUID string identifying this knowledge base label.
knowledgeBasePk
✅
string
Request Body
Request Parameters
name
string
Yes
Request Structure Example
Request Example Value
Code Examples
Response Body
Status Code: 200
Response Schema Example
Response Example Value
Partially Update Label
PATCH /api/knowledge-bases/{knowledgeBasePk}/labels/{id}/
Parameters
id
✅
string
A UUID string identifying this knowledge base label.
knowledgeBasePk
✅
string
Request Body
Request Parameters
name
string
No
Request Structure Example
Request Example Value
Code Examples
Response Body
Status Code: 200
Response Schema Example
Example Response Value
Delete Label
DELETE /api/knowledge-bases/{knowledgeBasePk}/labels/{id}/
Parameters
id
✅
string
A UUID string identifying this knowledge base label.
knowledgeBasePk
✅
string
Code Examples
Response
204
No response body
Upload File to Knowledge Base
POST /api/knowledge-bases/{knowledgeBasePk}/files/
Parameters
knowledgeBasePk
✅
string
fileType
❌
string
Filter by file type, e.g., pdf, docx, txt, xlsx, etc.
knowledgeBase
❌
string
Knowledge Base ID
page
❌
integer
A page number within the paginated result set.
pageSize
❌
integer
Number of results to return per page.
query
❌
string
Search keyword, can search by file name or file ID.
status
❌
string
Filter by file status. Possible values: `initial` (Initializing), `processing` (Processing), `done` (Done), `deleting` (Deleting), `deleted` (Deleted), `failed` (Failed). `initial`: Initial ; `processing`: Processing ; `done`: Done ; `deleting`: Deleting ; `deleted`: Deleted ; `faile...
Request Body
Request Parameters
files
array[ChatbotFileCreate]
Yes
Supports batch upload of multiple files, with a limit of 50 files per request
Request Structure Example
Request Example Value
Code Examples
Response Body
Status Code: 201
Response Schema Example
Response Example Value
Batch Delete Files
POST /api/knowledge-bases/{knowledgeBasePk}/files/batch-delete/
Parameters
knowledgeBasePk
✅
string
Request Body
Request Parameters
ids
array[string]
Yes
Request Structure Example
Request Example Value
Code Examples
Response Body
204
No response body
List Files in a Knowledge Base
GET /api/knowledge-bases/{knowledgeBasePk}/files/
Parameters
knowledgeBasePk
✅
string
fileType
❌
string
Filter by file type, e.g., pdf, docx, txt, xlsx, etc.
knowledgeBase
❌
string
Knowledge Base ID
page
❌
integer
A page number within the paginated result set.
pageSize
❌
integer
Number of results to return per page.
query
❌
string
Search keyword, can search by file name or file ID
status
❌
string
Filter by file status. Available values: `initial`: Initial ; `processing`: Processing ; `done`: Done ; `deleting`: Deleting ; `deleted`: Deleted ; `faile...
Code Examples
Response Body
Status Code: 200
Response Schema Example
Example Response Value
Get Specific File Details
GET /api/knowledge-bases/{knowledgeBasePk}/files/{id}/
Parameters
id
✅
string
A UUID string identifying this Chatbot File.
knowledgeBasePk
✅
string
Code Examples
Response Body
Status Code: 200
Response Schema Example
Response Example Value
Update File Information
PUT /api/knowledge-bases/{knowledgeBasePk}/files/{id}/
Parameters
id
✅
string
A UUID string identifying this Chatbot File.
knowledgeBasePk
✅
string
Request Body
Request Parameters
filename
string
Yes
File name
file
string (uri)
Yes
The file to upload
knowledgeBase
object (contains 2 properties: id, name)
No
knowledgeBase.id
string (uuid)
Yes
parser
string (uuid)
No
labels
array[IdName]
No
rawUserDefineMetadata
object
No
Request Structure Example
Request Example Value
Code Examples
Response Body
Status Code: 200
Response Schema Example
Response Example Value
Partially Update File
PATCH /api/knowledge-bases/{knowledgeBasePk}/files/{id}/
Parameters
id
✅
string
A UUID string identifying this Chatbot File.
knowledgeBasePk
✅
string
Request Body
Request Parameters
filename
string
No
File name
file
string (uri)
No
The file to upload
knowledgeBase
object (contains 2 properties: id, name)
No
knowledgeBase.id
string (uuid)
Yes
parser
string (uuid)
No
labels
array[IdName]
No
rawUserDefineMetadata
object
No
Request Structure Example
Request Example Value
Code Examples
Response Body
Status Code: 200
Response Schema Example
Response Example Value
Partially Update Files
PATCH /api/knowledge-bases/{knowledgeBasePk}/files/batch-reparse/
Parameters
knowledgeBasePk
✅
string
fileType
❌
string
Filter by file type, e.g., pdf, docx, txt, xlsx, etc.
knowledgeBase
❌
string
Knowledge Base ID
page
❌
integer
A page number within the paginated result set.
pageSize
❌
integer
Number of results to return per page.
query
❌
string
Search keyword, can search by file name or file ID
status
❌
string
Filter by file status, possible values: initial, processing, done, deleting, deleted, failed initial: Initial ; processing: Processing ; done: Done ; deleting: Deleting ; deleted: Deleted ; faile...
Code Examples
Response Body
Status Code: 200
Response Schema Example
Response Example Value
Delete File
DELETE /api/knowledge-bases/{knowledgeBasePk}/files/{id}/
Parameters
id
✅
string
A UUID string identifying this Chatbot File.
knowledgeBasePk
✅
string
Code Examples
Response
204
No response body
Create New FAQ
POST /api/knowledge-bases/{knowledgeBasePk}/faqs/
Parameters
knowledgeBasePk
✅
string
Request Body
Request Parameters
question
string
Yes
answer
string
Yes
answerMediaUrls
object
No
URLs for media files such as images and videos in the answer
labels
array[IdName]
No
rawUserDefineMetadata
object
No
knowledgeBase
object (with 2 properties: id, name)
No
knowledgeBase.id
string (uuid)
Yes
Request Structure Example
Request Example Value
Code Example
Response Body
Status Code: 201
Response Schema Example
Response Example Value
Batch Delete FAQs
POST /api/knowledge-bases/{knowledgeBasePk}/faqs/batch-delete/
Parameters
knowledgeBasePk
✅
string
Request Body
Request Parameters
ids
array[string]
No
Request Structure Example
Request Example Value
Code Examples
Response Body
204
No response body
List all FAQs for a specific knowledge base
GET /api/knowledge-bases/{knowledgeBasePk}/faqs/
Parameters
knowledgeBasePk
✅
string
page
❌
integer
A page number within the paginated result set.
pageSize
❌
integer
Number of results to return per page.
query
❌
string
Code Examples
Response Body
Status Code: 200
Response Schema Example
Response Example Value
Get Specific FAQ Details
GET /api/knowledge-bases/{knowledgeBasePk}/faqs/{id}/
Parameters
id
✅
string
A UUID string identifying this FAQ.
knowledgeBasePk
✅
string
Code Examples
Response Body
Status Code: 200
Response Schema Example
Response Example Value
Update FAQ
PUT /api/knowledge-bases/{knowledgeBasePk}/faqs/{id}/
Parameters
id
✅
string
A UUID string identifying this FAQ.
knowledgeBasePk
✅
string
Request Body
Request Parameters
question
string
Yes
answer
string
Yes
answerMediaUrls
object
No
URLs for media files such as images and videos in the answer
labels
array[IdName]
No
rawUserDefineMetadata
object
No
knowledgeBase
object (contains 2 properties: id, name)
No
knowledgeBase.id
string (uuid)
Yes
Request Structure Example
Request Example Value
Code Examples
Response Body
Status Code: 200
Response Schema Example
Response Example Value
Partially Update FAQ
PATCH /api/knowledge-bases/{knowledgeBasePk}/faqs/{id}/
Parameters
id
✅
string
A UUID string identifying this FAQ.
knowledgeBasePk
✅
string
Request Body
Request Parameters
question
string
No
answer
string
No
answerMediaUrls
object
No
URLs for media files such as images and videos in the answer
labels
array[IdName]
No
rawUserDefineMetadata
object
No
knowledgeBase
object (contains 2 properties: id, name)
No
knowledgeBase.id
string (uuid)
Yes
Request Schema Example
Request Example Value
Code Examples
Response Body
Status Code: 200
Response Schema Example
Response Example Value
Delete FAQ
DELETE /api/knowledge-bases/{knowledgeBasePk}/faqs/{id}/
Parameters
id
✅
string
A UUID string identifying this FAQ.
knowledgeBasePk
✅
string
Code Examples
Response
204
No response body
Last updated
Was this helpful?
