CRBNai API
  1. Knowledge Bots
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. Knowledge Bots

Create Knowledge Bot

POST
/api/knowledge-bots
kb
This will create a new Knowledge Bot.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://app.crbnai.com/api/knowledge-bots' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "string",
    "description": "string",
    "embeddable": true,
    "llm_config": {
        "model": "string",
        "vendor": "string"
    },
    "user_metadata": "string"
}'
Response Response Example
{
  "title": "veniam",
  "language_model": "fugiat",
  "owner_id": "4adb518a-9f3c-4bae-b766-fbc60153c9c7",
  "documents": [
    {
      "name": "accusamus",
      "id": "863dbbc3-8868-4ded-b175-0666e8d6333e",
      "created_at": "2039-02-27T09:46:49.965Z",
      "status": "dolorum"
    },
    {
      "name": "qui",
      "created_at": "2010-12-07T06:32:48.393Z",
      "status": "nobis",
      "id": "e4ba9221-b667-4739-8633-d809c27d7ed3"
    }
  ],
  "created_at": "2002-04-13T00:53:20.094Z",
  "id": "5042f1aa-3925-4d90-8049-cef5840a6f4d",
  "description": "Non itaque beatae repudiandae non earum pariatur nisi aliquid numquam. Quo iure perspiciatis necessitatibus necessitatibus. Sed rem fugit harum laudantium. Perspiciatis tempore soluta velit. Minus corrupti incidunt libero explicabo eius."
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
title
string 
required
User defined title for the Knowledge Bot.
description
string 
optional
User defined description of the Knowledge Bot.
embeddable
boolean 
optional
Allows embedding the Knowledge Bot for public use.
llm_config
object (LanguageModelConfig) 
optional
Information and configuration of the language model.
model
string 
required
The name of the used language model
vendor
string 
required
Vendor of the used language model
user_metadata
string  | integer  | boolean  | array  | object  | number  | null 
optional
Arbitrary JSON metadata for a Knowledge Bot.
Examples

Responses

🟢200OK
application/json
Body
id
string <uuid>
optional
UUID of the Knowledge Bot.
title
string 
required
User defined title for the Knowledge Bot.
created_at
string 
optional
Date (ISO 8601) that the knowledge base was created at.
description
string 
optional
User defined description of the Knowledge Bot.
embeddable
boolean 
optional
Allows embedding the Knowledge Bot for public use.
llm_config
object (LanguageModelConfig) 
optional
Information and configuration of the language model.
model
string 
required
The name of the used language model
vendor
string 
required
Vendor of the used language model
owner_id
string <uuid>
optional
UUID of the Owner of this Knowledge Bot.
documents
array[object (Document) {4}] 
optional
id
string <uuid>
optional
UUID representing this Document.
name
string 
required
The title of this document.
status
string 
optional
Status of processing this document.
created_at
string <date-time>
optional
Date (ISO 8601) that this document was created at.
user_metadata
string  | integer  | boolean  | array  | object  | number  | null 
optional
Arbitrary JSON metadata for a Knowledge Bot.
Modified at 2023-12-14 17:23:13
Previous
Chat with a Knowledge Bot
Next
Get All Knowledge Bots
Built with