Get knowledgeSource

Returns a list of knowledge sources. Excluded website pages (whose source URL matches the parent connector’s sourceConfig.excludePaths) are filtered out of the response — this is required so Cortex’s sync_knowledge_base does not re-index excluded pages.

GET /knowledgeSource

Get knowledgeSource

cURL

curl --request GET \
  --url https://demo.enneo.ai/api/mind/knowledgeSource \
  --header 'Authorization: Bearer <token>'

200

{
  "name": "<string>",
  "title": "<string>",
  "answer": "<string>",
  "items": [
    {
      "id": 123,
      "type": "faq",
      "status": "active",
      "source": "https://company.com/faq/376189",
      "name": "Opening hours",
      "tags": [
        70,
        71
      ],
      "teams": [
        1,
        2
      ],
      "readByAgents": [
        {
          "id": 1,
          "name": "John Doe",
          "readAt": "2024-11-29 14:38:12"
        }
      ],
      "title": "Opening hours",
      "text": "Our service hours are from 8am to 5pm. We are closed on weekends. [...]",
      "confidential": false,
      "excluded": false
    }
  ]
}

Authorizations

bearerAuthcookieAuth

Authorization · string · header · required

JWT-based authentication

Query Parameters

limit · integer · default: 100

The number of items to return

Required range: 1 <= x <= 1000

offset · integer · default: 0

The number of items to skip

Required range: x >= 0

parent · integer

The parent of the knowledgeSource to filter by

q · string

The search query to filter by. When specified other parameters are ignored

modifiedAfter · string<date-time>

Filter knowledge sources modified on or after this date. Must be in MySQL datetime format (Y-m-d H:i:s)

orderByField · enum<string> · default: name

Field to sort by. Applied to all list results, including fulltext search results.

Available options: name, views, modifiedAt, createdAt

orderByDirection · enum<string> · default: asc

Sort direction applied to orderByField. Defaults to asc; for non-name fields (views, modifiedAt, createdAt) callers typically want desc (most popular / most recent first) and should pass it explicitly.

Available options: asc, desc

Response

200

application/json

Successful operation

name · string | null

The name of the parent

title · string | null

The title of the parent

answer · string | null

The answer to the search query

items · object[]

Show child attributes