Upload Knowledge Base File
Upload a knowledge base file to a specific call flow.
Headers
x-api-keystringrequiredAPI key used for authenticating requests to the API.
x-workspace-idstringrequiredWorkspace identifier for the API.
Path Parameters
idstringrequiredThe unique identifier of the call flow to which the knowledge base file will be uploaded.
Request Body
filefilerequiredThe knowledge base file to upload. Accepted file formats are PDF (.pdf), plain text (.txt), Word document (.docx), and Markdown (.md).
Only one file can be uploaded per request.
Response Fields
_idstringThe unique identifier for the call flow to which the knowledge base file has been uploaded.
workspaceIdstringThe identifier of the workspace associated with the call flow.
settingsobjectContains the updated settings for the call flow following the file upload.
knowledgeBaseFilesarrayAn array of objects representing the knowledge base files associated with the call flow. Each object in this array provides details about the uploaded files, including:
filenamestringThe name of the file as stored in the system.
keystringA unique key or identifier used internally to reference the file.
urlstringA URL where the uploaded file can be accessed or downloaded.
{
"_id": "flowId",
"workspaceId": "workspaceIdExample",
"settings": {
"knowledgeBaseFiles": [
{
"filename": "exampleFile.pdf",
"key": "s3FileKey",
"url": "https://example.com/file.pdf"
}
]
}
}