GET
/
api
/
v1
/
knowledgebase
curl --request GET \
  --url https://cx-staging-three.fly.dev/api/v1/knowledgebase \
  --header 'Authorization: Basic <encoded-value>'
{
  "knowledgeBases": [
    {
      "id": "44264f7c-bf2b-47ad-baf9-48b509dc55c0",
      "name": "Test",
      "type": "faq",
      "agents": [
        "c84951a0-8354-40b0-a1ee-c43d259f6a40"
      ],
      "title": "Test",
      "text": "Test",
      "description": "Test",
      "refreshFrequency": "1h",
      "workspace": "34319b9a-625a-4eef-a554-7ed0d27fce6b",
      "isEveryone": false,
      "status": "active"
    },
    {
      "id": "fc4426d7-3bd4-4146-a69a-011ca2227d3a",
      "name": "Test 2",
      "type": "faq",
      "urls": [
        "https://example.com/knowledge-base"
      ],
      "agents": [
        "2"
      ],
      "title": "Test 2",
      "description": "Test 2 description",
      "text": "Test 2 text",
      "refreshFrequency": "1d",
      "workspace": "34319b9a-625a-4eef-a554-7ed0d27fce6b",
      "isEveryone": true,
      "status": "inactive"
    }
  ],
  "total": 1,
  "pages": 1
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
number
​
limit
number

Response

200
application/json
Retireved list of knowledge bases
​
knowledgeBases
string[]
required

List of knowledge base in the workspace

Example:
[
  {
    "id": "44264f7c-bf2b-47ad-baf9-48b509dc55c0",
    "name": "Test",
    "type": "faq",
    "agents": ["c84951a0-8354-40b0-a1ee-c43d259f6a40"],
    "title": "Test",
    "text": "Test",
    "description": "Test",
    "refreshFrequency": "1h",
    "workspace": "34319b9a-625a-4eef-a554-7ed0d27fce6b",
    "isEveryone": false,
    "status": "active"
  },
  {
    "id": "fc4426d7-3bd4-4146-a69a-011ca2227d3a",
    "name": "Test 2",
    "type": "faq",
    "urls": ["https://example.com/knowledge-base"],
    "agents": ["2"],
    "title": "Test 2",
    "description": "Test 2 description",
    "text": "Test 2 text",
    "refreshFrequency": "1d",
    "workspace": "34319b9a-625a-4eef-a554-7ed0d27fce6b",
    "isEveryone": true,
    "status": "inactive"
  }
]
​
total
number
required

Total of knowledge base

Example:

1

​
pages
number
required

Number of pages

Example:

1