📖Upload Knowledge Bank

API to upload Knowledge bank for a user.

Upload a new Document.

https://beta.convai.com/character/knowledge-bank/upload

Beta Endpoint

Headers

Name	Value
Content-Type	application/json
CONVAI-API-KEY	dummy-api-key

Body

Name	Type	Description
file	upload(file)	File to be uploaded

Response

200

{
  "file_name": "dummy_name",
  "file_size": "lengtth of file in byte",
  "id": "document_id",
  "is_available": true,
  "status": "status of file",
  "timestamp": "1898-10-09T20:35:53.0Z"
}

400

401

403

500

Upload Knowledge Bank for a character. Supports only Pdf, CSV and txt format

post

Authorizations

ApiKeyAuth

CONVAI-API-KEYstringRequired

Header parameters

CONVAI-API-KEYstring · uuidRequired

Body

multipart/form-data

filestring · binaryOptional

Responses

200

ok

application/json

400

Bad Request

401

Unauthorized

403

Forbidden

500

Server Error

application/json

post

/knowledge-bank/upload

HTTPcURLJavaScriptPython

POST /character/knowledge-bank/upload HTTP/1.1
Host: beta.convai.com
CONVAI-API-KEY: 123e4567-e89b-12d3-a456-426614174000
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{
  "id": "text",
  "file_name": "text",
  "is_available": true,
  "timestamp": "2025-12-12T08:03:32.988Z",
  "status": "text",
  "file_size": "text"
}