Zum Hauptinhalt springen
GET
/
knowledgeSource
Get knowledgeSource
curl --request GET \
  --url https://demo.enneo.ai/api/mind/knowledgeSource \
  --header 'Authorization: Bearer <token>'
{
  "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
}

Autorisierungen

Authorization
string
header
erforderlich

JWT-based authentication

Abfrageparameter

limit
integer
Standard:50

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.

Erforderlicher Bereich: x >= 1
offset
integer
Standard:0

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

Erforderlicher Bereich: 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>
Standard:name

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

Verfügbare Optionen:
name,
views,
modifiedAt,
createdAt
orderByDirection
enum<string>
Standard: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.

Verfügbare Optionen:
asc,
desc

Antwort

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[]
total
integer

Total number of visible items in the folder (after ACL filtering). Present only when parent is specified. Use with limit/offset to render pagination controls.

Beispiel:

42

offset
integer

The offset used for this page. Present only when parent is specified.

Beispiel:

0

limit
integer

The limit used for this page. Present only when parent is specified.

Beispiel:

50