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
List of all available AI agents as an tree based on associated tag
curl --request GET \
--url https://demo.enneo.ai/api/mind/aiAgents/tree{
"aiAgentsTree": {
"id": 123,
"name": "Complaint",
"fullName": "Second Level: Complaint",
"parent": 6,
"reference": "ticket",
"type": "skill",
"visibility": "public",
"color": "grey",
"properties": {},
"complexity": "moderate",
"sla": 8,
"priority": "do-not-change",
"channels": [
"email",
"chat"
],
"subchannels": [
2,
4
],
"detectionDetails": {},
"assignment": [
"assignBySubchannel",
"assignByCustomLogic"
],
"testCase": {},
"modifiedBy": "John Doe",
"modifiedAt": "2024-08-29 14:38:12",
"aiAgents": [
{
"id": 1,
"tagId": 41,
"channels": [
"all"
],
"name": "Change bank data (Code)",
"description": "Customer wants to change his bank data",
"appearance": {},
"exampleTicketIds": [
8,
26
],
"settings": {}
}
],
"children": [
{
"id": 123,
"name": "Complaint",
"fullName": "Second Level: Complaint",
"parent": 6,
"reference": "ticket",
"type": "skill",
"visibility": "public",
"color": "grey",
"properties": {},
"complexity": "moderate",
"sla": 8,
"priority": "do-not-change",
"channels": [
"email",
"chat"
],
"subchannels": [
2,
4
],
"detectionDetails": {},
"assignment": [
"assignBySubchannel",
"assignByCustomLogic"
],
"testCase": {},
"modifiedBy": "John Doe",
"modifiedAt": "2024-08-29 14:38:12",
"aiAgents": [
{
"id": 1,
"tagId": 41,
"channels": [
"all"
],
"name": "Change bank data (Code)",
"description": "Customer wants to change his bank data",
"appearance": {},
"exampleTicketIds": [
8,
26
],
"settings": {}
}
]
}
]
}
}Authorizations
Cookie-based authentication
Query Parameters
The number of items to return
1 < x < 1000The number of items to skip
x > 0Filter criteria based on category. If ommited, only ai agents will be returned ("intent")
all, intent, template Filter criteria based on type of the executor. If ommited, all types are returned.
sourceCode, apiCall, visualEditor Output format. Either short (only name/id), medium (key facts) or full (all details). Defaults to full.
short, medium, full Search query for fulltext search in name and description fields. Results are ordered by relevance when search is used
Response
Tag object with intent candidates inside
Internal id, e.g. 123
e.g. "Complaint"
The full name when not shown in a tree
The id of the parent tag. null if on root level. Can be created to create the tree structure of tags
To what this tag can be assigned to
ticket, contract, customer Type of the tag
skill, product, brand, customerProperty, contractProperty, other Visibility of the tag
public, private, disabled Color of the tag. Default is grey
grey, green, red, blue, yellow, purple, orange, teal An array of strings that specify special properties. Currently only ['defaultSkill'], if this tag should be assigned if no skill was found
defaultSkill The complexity of the tag
SLA in business hours. So if we have business hours from 9-17h, an 8 hour SLA means ticket has to be solved within one day. NULL means no SLA is assigned.
If set to anything other than do-not-change, then the ticket priority will be set to this value if the tag was assigned (either manually or via AI)
do-not-change, low, medium, high Channels for which this tag can be detected. If empty or null, then this tag can be assigned to all channels.
Subchannels (=Mailboxes/Chat channels) for which this tag can be detected. If empty or null, then this tag can be assigned to all subchannels.
Details how the AI agent is detected
Specifies how this tag is being assigned. The details in the assignment are specified in the settings page of the tag. So for example 'assignBySubchannel', 'assignByCustomLogic' means this tag is auto-assigned for certain subchannels, and using a custom logic defined in an executor.
assignByChannel, assignBySubchannel, assignByTicketProperty, assignByContractProperty, assignByCustomerProperty, assignByCustomLogic, assignByAI Test case for the tag
The user that last modified the tag
The date and time when the tag was last modified
Unique identifier of the AI agent (unsigned integer)
x > 0Category of this ai agent
Channels this ai agent is available on
The name of the AI agent visible to the user. It is also used by the LLM to validate if the intent is correctly identified
The description of the AI agent as defined by the user. It is also used by the LLM to validate if the intent is correctly identified
Tag object with intent candidates inside
Internal id, e.g. 123
e.g. "Complaint"
The full name when not shown in a tree
The id of the parent tag. null if on root level. Can be created to create the tree structure of tags
To what this tag can be assigned to
ticket, contract, customer Type of the tag
skill, product, brand, customerProperty, contractProperty, other Visibility of the tag
public, private, disabled Color of the tag. Default is grey
grey, green, red, blue, yellow, purple, orange, teal An array of strings that specify special properties. Currently only ['defaultSkill'], if this tag should be assigned if no skill was found
defaultSkill The complexity of the tag
SLA in business hours. So if we have business hours from 9-17h, an 8 hour SLA means ticket has to be solved within one day. NULL means no SLA is assigned.
If set to anything other than do-not-change, then the ticket priority will be set to this value if the tag was assigned (either manually or via AI)
do-not-change, low, medium, high Channels for which this tag can be detected. If empty or null, then this tag can be assigned to all channels.
Subchannels (=Mailboxes/Chat channels) for which this tag can be detected. If empty or null, then this tag can be assigned to all subchannels.
Details how the AI agent is detected
Specifies how this tag is being assigned. The details in the assignment are specified in the settings page of the tag. So for example 'assignBySubchannel', 'assignByCustomLogic' means this tag is auto-assigned for certain subchannels, and using a custom logic defined in an executor.
assignByChannel, assignBySubchannel, assignByTicketProperty, assignByContractProperty, assignByCustomerProperty, assignByCustomLogic, assignByAI Test case for the tag
The user that last modified the tag
The date and time when the tag was last modified
Unique identifier of the AI agent (unsigned integer)
x > 0Category of this ai agent
Channels this ai agent is available on
The name of the AI agent visible to the user. It is also used by the LLM to validate if the intent is correctly identified
The description of the AI agent as defined by the user. It is also used by the LLM to validate if the intent is correctly identified
curl --request GET \
--url https://demo.enneo.ai/api/mind/aiAgents/tree{
"aiAgentsTree": {
"id": 123,
"name": "Complaint",
"fullName": "Second Level: Complaint",
"parent": 6,
"reference": "ticket",
"type": "skill",
"visibility": "public",
"color": "grey",
"properties": {},
"complexity": "moderate",
"sla": 8,
"priority": "do-not-change",
"channels": [
"email",
"chat"
],
"subchannels": [
2,
4
],
"detectionDetails": {},
"assignment": [
"assignBySubchannel",
"assignByCustomLogic"
],
"testCase": {},
"modifiedBy": "John Doe",
"modifiedAt": "2024-08-29 14:38:12",
"aiAgents": [
{
"id": 1,
"tagId": 41,
"channels": [
"all"
],
"name": "Change bank data (Code)",
"description": "Customer wants to change his bank data",
"appearance": {},
"exampleTicketIds": [
8,
26
],
"settings": {}
}
],
"children": [
{
"id": 123,
"name": "Complaint",
"fullName": "Second Level: Complaint",
"parent": 6,
"reference": "ticket",
"type": "skill",
"visibility": "public",
"color": "grey",
"properties": {},
"complexity": "moderate",
"sla": 8,
"priority": "do-not-change",
"channels": [
"email",
"chat"
],
"subchannels": [
2,
4
],
"detectionDetails": {},
"assignment": [
"assignBySubchannel",
"assignByCustomLogic"
],
"testCase": {},
"modifiedBy": "John Doe",
"modifiedAt": "2024-08-29 14:38:12",
"aiAgents": [
{
"id": 1,
"tagId": 41,
"channels": [
"all"
],
"name": "Change bank data (Code)",
"description": "Customer wants to change his bank data",
"appearance": {},
"exampleTicketIds": [
8,
26
],
"settings": {}
}
]
}
]
}
}