Zum Hauptinhalt springen
PATCH
/
knowledgeSource
/
{id}
Update knowledgeSource
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
}
'
{
  "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
}

Documentation Index

Fetch the complete documentation index at: https://docs.enneo.ai/llms.txt

Use this file to discover all available pages before exploring further.

Autorisierungen

​
Authorization
string
header
erforderlich

JWT-based authentication

Pfadparameter

​
id
integer
erforderlich

The id of the knowledgeSource to retrieve

Body

application/json

Knowledge source object

​
id
integer

Internal id, e.g. 123

Beispiel:

123

​
type
enum<string>
Standard:faq

Type of knowledge source

Verfügbare Optionen:
faq,
work-instruction,
document,
other,
news,
website
​
status
enum<string>
Standard:active

Status of the knowledge source

Verfügbare Optionen:
active,
archived,
deleted
Beispiel:

"active"

​
source
string
Standard:""

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

Beispiel:

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

​
name
string

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

Beispiel:

"Opening hours"

​
tags
integer[] | null

Tags that are assigned to this knowledge source

Beispiel:
[70, 71]
​
teams
integer[]

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

Beispiel:
[1, 2]
​
title
string | null

Title of knowledge source

Beispiel:

"Opening hours"

​
text
string

Full text that was used as source

Beispiel:

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

​
confidential
boolean
Standard:false

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

Beispiel:

false

​
excluded
boolean
Standard: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.

Antwort

Successful operation

Knowledge source object

​
success
boolean

Operation was successful

Beispiel:

true

​
id
integer

Internal id, e.g. 123

Beispiel:

123

​
type
enum<string>
Standard:faq

Type of knowledge source

Verfügbare Optionen:
faq,
work-instruction,
document,
other,
news,
website
​
status
enum<string>
Standard:active

Status of the knowledge source

Verfügbare Optionen:
active,
archived,
deleted
Beispiel:

"active"

​
source
string
Standard:""

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

Beispiel:

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

​
name
string

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

Beispiel:

"Opening hours"

​
tags
integer[] | null

Tags that are assigned to this knowledge source

Beispiel:
[70, 71]
​
teams
integer[]

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

Beispiel:
[1, 2]
​
readByAgents
object[]
read-only

Agents that have read the knowledge source

Beispiel:
[
  {
    "id": 1,
    "name": "John Doe",
    "readAt": "2024-11-29 14:38:12"
  }
]
​
title
string | null

Title of knowledge source

Beispiel:

"Opening hours"

​
text
string

Full text that was used as source

Beispiel:

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

​
confidential
boolean
Standard:false

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

Beispiel:

false

​
excluded
boolean
Standard: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.