POST
/
api
/
v1
/
knowledgebase
curl --request POST \
  --url https://cx-staging-three.fly.dev/api/v1/knowledgebase \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "How to reset my password",
  "type": "faq",
  "agentIds": [
    "a8c87faa-219c-4fa9-bbc0-8acf826d9e6a",
    "97e07544-bf7a-4af6-864c-07736fffb5c2"
  ],
  "title": "How to reset my password",
  "text": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry'\''s standard dummy text ever since the 1500s",
  "description": "This is a knowledge base",
  "urls": [
    "https://example.com/knowledge-base"
  ],
  "refreshFrequency": "manual"
}'
{
  "name": "How to reset my password",
  "type": "faq",
  "url": "https://example.com/knowledge-base",
  "urls": [
    "https://example.com/knowledge-base"
  ],
  "agents": [
    "a8c87faa-219c-4fa9-bbc0-8acf826d9e6a",
    "97e07544-bf7a-4af6-864c-07736fffb5c2"
  ],
  "title": "How to reset my password",
  "status": "active",
  "description": "This is a description of the knowledge base",
  "text": "This is a text of the knowledge base",
  "isEveryone": false,
  "refreshFrequency": "1h",
  "workspace": "34319b9a-625a-4eef-a554-7ed0d27fce6b"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
Input data for creating a new knowledge base
​
name
string
required
deprecated

The name of the knowledge base

Example:

"How to reset my password"

​
type
string
required

The type of the knowledge base

Example:

"faq"

​
agentIds
string[]
required

The list of agent IDs of the knowledge base that needs to be given access to this knowledgebase

Example:
[
  "a8c87faa-219c-4fa9-bbc0-8acf826d9e6a",
  "97e07544-bf7a-4af6-864c-07736fffb5c2"
]
​
title
string
required

The title of the knowledge base

Example:

"How to reset my password"

​
text
string
required

The textual content of the knowledge base

Example:

"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s"

​
description
string
required

The description of the knowledge base

Example:

"This is a knowledge base"

​
urls
string[]
required

The list of website URLs of the knowledge base, please see: (knowledgebase/extract-urls) for getting these urls

Example:
["https://example.com/knowledge-base"]
​
refreshFrequency
string
required

The refresh frequency of the knowledge base

Example:

"manual"

Response

200 - application/json
Created knowledge base
​
name
string
required
deprecated

The name of the knowledge base

Example:

"How to reset my password"

​
type
string
required

The type of the knowledge base

Example:

"faq"

​
url
string
required
deprecated

The URL of the knowledge base

Example:

"https://example.com/knowledge-base"

​
urls
string[]
required

The list of website URLs of the knowledge base

Example:
["https://example.com/knowledge-base"]
​
agents
string[]
required

The list of agent IDs of the knowledge base

Example:
[
  "a8c87faa-219c-4fa9-bbc0-8acf826d9e6a",
  "97e07544-bf7a-4af6-864c-07736fffb5c2"
]
​
title
string
required

The title of the knowledge base

Example:

"How to reset my password"

​
status
string
required

The status of the knowledge base

Example:

"active"

​
description
string
required

The description of the knowledge base

Example:

"This is a description of the knowledge base"

​
text
string
required

The text of the knowledge base

Example:

"This is a text of the knowledge base"

​
isEveryone
boolean
required

Is the knowledge base accessible to everyone

Example:

false

​
refreshFrequency
string
required

The refresh frequency of the knowledge base

Example:

"1h"

​
workspace
string
required

The UUID of the workspace

Example:

"34319b9a-625a-4eef-a554-7ed0d27fce6b"