API Dokumentation
ticket
- GETGet next ticket id to work on
- POSTGet a list of tickets
- POSTCreate a ticket
- PATCHUpdate a few tickets at once
- GETGet a ticket
- PATCHUpdate a ticket
- GETGet ticket variables
- GETGet a tickets history
- POSTForward a ticket
- POSTAuto-execute a ticket
- GETPing a ticket
- GETGet ticket activity
- GETGet ticket stats
- GETGet agent queue status
customer
intent
aiAgent
- GETList of all available AI agents as an array
- GETList of all available AI agents as an tree based on associated tag
- POSTLoad enneo default AI Agents
- POSTCreate a new aiAgent
- GETGet an AI Agent by id
- DELDelete an existing AI Agent
- PATCHUpdate an existing AI Agent
- GETGet similar tickets for an AI Agent
- POSTPreview an AI Agent
- POSTGet the outcome of an AI Agent
aiQualityCheck
- GETGet all test runs with pagination
- POSTSchedule a new AI quality check
- GETGet a specific test run by ID
- DELDelete a specific test run by ID
- PATCHUpdate the expected result of a test ticket
- PATCHAccept the expected result of a test ticket
- POSTAccept ALL the expected results of for a test run
- GETGet all AI agents for which test runs can be triggered
- GETGet all AI agents for which test runs can be triggered
- GETGet test cases by AI agent ID
- POSTAdd test cases for an AI agent
- DELDelete a test case by ID
- PATCHUpdate a test case by ID
intentTemplate
profile
team
reminder
settings
- GETGet settings of a client
- POSTUpdate multiple settings at once
- GETGet settings of a client and return the results in a compact form
- GETGet settings of a client in a grouped way for a category
- PUTUpdate setting
- GETSearch settings
- GETGet Subchannels
- POSTAdd a new Subchannel
- DELDelete a Subchannel
- GETGet User Defined Functions
- POSTAdd a new User Defined Function
- DELDelete a User Defined Function
- GETRedirect to Microsoft authorization page
- GETCallback for Microsoft authorization
tag
cron
version
knowledgeSourceStructure
knowledgeSource
pcProxy
cortex
Get knowledgeSource
curl --request GET \
--url https://demo.enneo.ai/api/mind/knowledgeSource
{
"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
}
]
}
Authorizations
Cookie-based authentication
Query Parameters
The number of items to return
1 < x < 1000
The number of items to skip
x > 0
The parent of the knowledgeSource to filter by
The search query to filter by. When specified other parameters are ignored
Response
The name of the parent
The title of the parent
The answer to the search query
Knowledge source object
Internal id, e.g. 123
Type of knowledge source
faq
, work-instruction
, document
, other
, news
Status of the knowledge source
active
, archived
, deleted
URL to associated source. null for sources with internal ids (tickets and templates) or if non-existant (language model source)
Name of knowledge source, any requests with existing name will update the existing knowledge source
Tags that are assigned to this knowledge source
(!) Should be used only with type 'news' (otherwise ignored). Teams that are assigned to the knowledge source object
Title of knowledge source
Full text that was used as source
If true, then this knowledge source is only visible to agents
curl --request GET \
--url https://demo.enneo.ai/api/mind/knowledgeSource
{
"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
}
]
}