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

Autorisierungen

​
Authorization
string
header
erforderlich

JWT-based authentication

Abfrageparameter

​
offset
integer
Standard:0

The number of items to skip before starting to collect the result set

​
limit
integer
Standard:1000

The numbers of items to return

Antwort

Successful operation

​
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
​
status
enum<string>
Standard:archived

Status of the knowledge source

Verfügbare Optionen:
archived
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[]

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