Update knowledgeSource

For file-type rows (uploaded via the files connector) only name, status, and text are accepted — other fields return 422. Editing text sets data.hasManualMarkdownEdits = true so the FE can warn before a re-upload would overwrite manual edits. The embeddingHash is intentionally NOT recomputed on text-only edits — it represents the parse hash of the original binary and stays stable until a real reindex / replace.

Website-type pages cannot be edited through this endpoint.

PATCH /knowledgeSource/{id}

Update knowledgeSource

cURL

curl --request PATCH \
  --url https://demo.enneo.ai/api/mind/knowledgeSource/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": 123,
  "type": "faq",
  "status": "active",
  "source": "https://company.com/faq/376189",
  "name": "Opening hours",
  "tags": [
    70,
    71
  ],
  "teams": [
    1,
    2
  ],
  "title": "Opening hours",
  "text": "Our service hours are from 8am to 5pm. We are closed on weekends. [...]",
  "confidential": false,
  "excluded": false
}
'

200

{
  "success": true,
  "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

Path Parameters

id · integer · required

The id of the knowledgeSource to retrieve

Body

application/json

Knowledge source object

id · integer

Internal id, e.g. 123

Example:

123

type · enum<string> · default: faq

Type of knowledge source

Available options: faq, work-instruction, document, other, news, website

status · enum<string> · default: active

Status of the knowledge source

Available options: active, archived, deleted

Example:

"active"

source · string · default: ""

URL to associated source. null for sources with internal ids (tickets and templates) or if non-existant (language model source)

Example:

"https://company.com/faq/376189"

name · string

Name of knowledge source, any requests with existing name will update the existing knowledge source

Example:

"Opening hours"

tags · integer[] | null

Tags that are assigned to this knowledge source

Example:

[70, 71]

teams · integer[]

(!) Should be used only with type 'news' (otherwise ignored). Teams that are assigned to the knowledge source object

Example:

[1, 2]

title · string | null

Title of knowledge source

Example:

"Opening hours"

text · string

Full text that was used as source

Example:

"Our service hours are from 8am to 5pm. We are closed on weekends. [...]"

confidential · boolean · default: false

If true, then this knowledge source is only visible to agents

Example:

false

excluded · boolean · default: false

For website-type pages only — true if the page URL matches the parent connector's sourceConfig.excludePaths. Excluded pages are filtered out of GET /knowledgeSource (bulk list) and return 404 from GET /knowledgeSource/{id} so Cortex sync stays consistent. The configuration view (which calls /knowledgeSourceStructure?withExcluded=true) sees them with this flag set so it can render the "Excluded" tag and the Include action.

Response

200

application/json

Successful operation

Knowledge source object

success · boolean

Operation was successful

Example:

true

id · integer

Internal id, e.g. 123

Example:

123

type · enum<string> · default: faq

Type of knowledge source

Available options: faq, work-instruction, document, other, news, website

status · enum<string> · default: active

Status of the knowledge source

Available options: active, archived, deleted

Example:

"active"

source · string · default: ""

URL to associated source. null for sources with internal ids (tickets and templates) or if non-existant (language model source)

Example:

"https://company.com/faq/376189"

name · string

Name of knowledge source, any requests with existing name will update the existing knowledge source

Example:

"Opening hours"

tags · integer[] | null

Tags that are assigned to this knowledge source

Example:

[70, 71]

teams · integer[]

(!) Should be used only with type 'news' (otherwise ignored). Teams that are assigned to the knowledge source object

Example:

[1, 2]

readByAgents · object[] · read-only

Agents that have read the knowledge source

Show child attributes

Example:

[
  {
    "id": 1,
    "name": "John Doe",
    "readAt": "2024-11-29 14:38:12"
  }
]

title · string | null

Title of knowledge source

Example:

"Opening hours"

text · string

Full text that was used as source

Example:

"Our service hours are from 8am to 5pm. We are closed on weekends. [...]"

confidential · boolean · default: false

If true, then this knowledge source is only visible to agents

Example:

false

excluded · boolean · default: false

For website-type pages only — true if the page URL matches the parent connector's sourceConfig.excludePaths. Excluded pages are filtered out of GET /knowledgeSource (bulk list) and return 404 from GET /knowledgeSource/{id} so Cortex sync stays consistent. The configuration view (which calls /knowledgeSourceStructure?withExcluded=true) sees them with this flag set so it can render the "Excluded" tag and the Include action.