Welcome to Knowbase.ai API

Knowbase.ai API access allows you to chat with your files easily by integrating it with your own application or setup.

Here you'll find all the documentation you need to get up and running with our Knowbase.ai API.

Let's dive in 👇

Features

  • File Upload: Securely upload various document types for processing.

  • Library Access: Retrieve details of files stored in your library.

  • File Deletion: Remove files from your library as needed.

  • Summary Generation: Get concise summaries of text files.

  • Query Interface: Send queries related to your documents and receive responses.

Supported File Types

  • PDF (.pdf)

  • Microsoft Word (.doc, .docx)

  • Plain Text (.txt)

  • Microsoft PowerPoint (.ppt, .pptx)

File Size Limit

Maximum file size for uploads is 5MB.

Steps involved in using our API

  1. You need to generate your API key in your account settings (Account - Manage Account - Generate API Key) to call our API endpoints (Note: you need to be on a paid plan to get your API key)

  2. In order to chat with any file you need to have a file_id of it

  3. To get thefile_id, upload the file. Or, if the file is uploaded via the web portal, the file_id is retrived using /library endpoint

  4. After you get the file_id use that in your chat endpoint to get the responses to your questions by sending a message

  5. If you no longer want to chat with a file, then you can remove the file using its file_id through delete endpoint.

Last updated