General

Create knowledge base

This operation initialises an empty knowledge base and attaches it to your user. You always need to perform this operation after registartion. Upon a successful registration you recieve a KB ID which you can then use to manage or query the KB.

The request body contains the following fields:

name: The name of the knowledge base.
type: Specifies the type of the knowledge base.
- query: This type is designated for use with the Ask service.
- tech: Coming soon! This type is designated for providing guards or constraints for the Ask service, ensuring that queries are processed within specified guidelines.
paragraps: Contains optional chunking parameters.
- chunkSize: The maximum size of each chunk, in tokens.
- chunkOverlap: The number of overlapping tokens between consecutive chunks.

POST

curl --request POST \
  --url https://app.docs.bynesoft.com/api/knowledge-base/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "string",
  "paragraphs": {
    "chunkOverlap": 400,
    "chunkSize": 800
  },
  "type": "query"
}'

{
  "id": "<string>",
  "name": "<string>",
  "type": "query",
  "paragraphs": {
    "chunkSize": 123,
    "chunkOverlap": 123
  },
  "dateCreated": "<string>"
}

Authorizations

X-API-Key

string

header

required

Body

application/json

name

string | null

type

enum<string>

default:query

Available options:

query,

tech

paragraphs

object

Response

200

application/json

Successful Response

string

required

name

string

required

type

enum<string>

required

Available options:

query,

tech

paragraphs

object

required

dateCreated

string

required

List all users knowledge bases Get user knowledge base

curl --request POST \
  --url https://app.docs.bynesoft.com/api/knowledge-base/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "string",
  "paragraphs": {
    "chunkOverlap": 400,
    "chunkSize": 800
  },
  "type": "query"
}'

{
  "id": "<string>",
  "name": "<string>",
  "type": "query",
  "paragraphs": {
    "chunkSize": 123,
    "chunkOverlap": 123
  },
  "dateCreated": "<string>"
}

API Documentation

Authorizations

Body

Response