Get Knowledge Bot by ID

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

id

string

required

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

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

optional

Arbitrary JSON metadata for a Knowledge Bot.

Example

{
  "title": "eum",
  "language_model": "quod",
  "owner_id": "uuid",
  "documents": [
    {
      "name": "modi",
      "id": "a5f3a5df-5c4e-4f64-ae6c-fab3142e74cf",
      "created_at": "2077-08-04T04:48:45.453Z",
      "status": "beatae"
    },
    {
      "name": "labore",
      "id": "cbaca47a-dac4-4678-a294-7ea52a30ba93",
      "created_at": "2095-06-21T18:31:35.965Z",
      "status": "debitis"
    },
    {
      "name": "vero",
      "status": "minima",
      "created_at": "2020-07-18T16:11:44.61Z",
      "id": "777a2893-46ac-4680-b3da-b53bc95ee353"
    },
    {
      "name": "similique",
      "status": "rem",
      "id": "b138c936-ff6a-44ec-9d88-eccfada0627f",
      "created_at": "2054-02-28T19:58:12.24Z"
    }
  ],
  "description": "Id libero ducimus aspernatur delectus consectetur reprehenderit dolore. Eius cumque odio nostrum delectus pariatur consequuntur. Repellat ipsa enim vel minima quod error nesciunt. Hic error fuga mollitia excepturi. Ipsam totam voluptates eius vel deleniti labore laborum.",
  "id": "0b5a4682-4b61-4a67-a285-1690bafe1cdc",
  "created_at": "2034-04-17T00:43:35.426Z"
}