Get knowledgeSource

`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.

Folder listing (parent present): paginated. limit defaults to 50, maximum 500. Response includes total, offset, and limit for cursor-free pagination.

Global / search (parent absent, or q present): not paginated. limit defaults to 1000 and is not capped. total/offset/limit are not returned.

Query parameters

limitintegerquery

Maximum number of items to return. When parent is present (folder listing), defaults to 50 and is capped at 500. When parent is absent, defaults to 1000 with no server-side cap.

offsetintegerquery

Number of items to skip (zero-based). Only meaningful with parent.

parentintegerquery

The parent of the knowledgeSource to filter by

qstringquery

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

modifiedAfterstringquery

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

orderByFieldenumquery

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

orderByDirectionenumquery

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.

Responses

200 — Successful operation

Response Example

{
  "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,
      "access": {
        "blocked": true,
        "blockedItems": [
          {
            "id": 42,
            "kind": "article"
          },
          {
            "id": 57,
            "kind": "folder"
          }
        ]
      }
    }
  ],
  "total": 42,
  "offset": 0,
  "limit": 50
}

500 — Internal error