CRBNai API
  1. Guides
CRBNai API
  • README
  • Authentication
  • Guides
    • Creating a Knowledge Bot
  • API Keys
    • Get all API Keys
      GET
    • Create API Key
      POST
    • Delete API Key
      DELETE
  • Chats
    • Messages
      • Get Chat Messages
      • Post Chat Message
    • Recipes
      • Get All Chat Recipes
    • Get All Chats
      GET
    • Create Chat
      POST
  • Documents
    • Delete Document
      DELETE
    • Download Document
      GET
    • Update Document
      PUT
  • Knowledge Bots
    • Documents
      • Add Document to Knowledge Bot
      • Prepare Document Upload
    • Chats
      • Chat Messages
        • Get Messages of a Knowledge Bot chat
        • Post a message to a Knowlege Bot chat
      • Get all Knowledge Bot chats
      • Create Knowledge Bot chat
    • Chats - deprecated
      • Chat with a Knowledge Bot
    • Create Knowledge Bot
      POST
    • Get All Knowledge Bots
      GET
    • Get Knowledge Bot by ID
      GET
    • Delete Knowledge Bot by ID
      DELETE
    • Update Knowledge Bot by ID
      PUT
  1. Guides

Creating a Knowledge Bot

This guide provides a step-by-step overview of how to create a Knowledge Bot, including the process of uploading documents.

Overview#

Creating a Knowledge Bot with CRBN AI involves the following steps:
1.
Create an empty Knowledge Bot
2.
Prepare your documents for upload
3.
Upload your documents
4.
Announce the uploaded documents (temporary)

Steps#

1. Create an empty Knowledge Bot#

To create a new Knowledge Bot, send a single request to our API with the desired title for your bot. You will receive a unique id for your bot, which you'll need for the subsequent steps. For detailed instructions, refer to Create New Knowledge Bot.

2. Prepare Your Document Uploads#

Uploading documents is a two-step process that optimizes your bandwidth usage, especially for larger files like videos. Here's how it works:
Get the URLs for uploading your files by announcing your file names to the Prepare Document Upload API. You will receive a path and a signedUrl for each file you want to upload. These details are used in the second step below.

3. Upload your documents#

Use the provided signedUrl to send your documents to CRBN AI. Each file can be uploaded by sending the complete file within a PUT request to the respective signedUrl.

4. Announce the Uploaded Documents (temporary)#

After successfully uploading your documents, you need to inform CRBN AI about them. Use the path from step 2 to announce your documents to CRBN AI through the Add Document to Knowledge Bot API.
INFO
Please note that we are currently upgrading our infrastructure for improved reliability and security. This step is temporary until the transition is finished.
Once your documents are announced to our API, CRBN AI will display them in the user interface of your Knowledge Bot. It will then begin extracting and processing the content for further interaction through the Chat with a Knowledge Bot API.
Modified at 2023-10-19 09:15:55
Previous
Authentication
Next
Get all API Keys
Built with