Ticket
Conversation
Intent
AiAgent
- GETList of all available AI agents as an array
- GETList of all available AI agents as an tree based on associated tag
- GETGet list of available enneo default AI Agents
- 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
AI Quality Check
- 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
- PATCHStop 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 triggereddeprecated
- GETGet all AI agents for which test runs can be triggered
- GETGet test cases for a specific AI agent
- POSTAdd test cases for an AI agent
- DELDelete a test case by ID
- PATCHUpdate a test case by ID
Template
Profile
- GETSearch profiles
- PATCHUpdate multiple profiles at once
- GETGet currently logged in user's profile
- POSTCreate a new user
- GETPing endpoint to track user activity
- GETGet specific profile
- DELDelete specific profile
- PATCHUpdate specific profile
- GETExplain routing priorities for a user
- GETGet available options for analytics roles
- PATCHUpdate profile routing status
Team
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
Customer
Wiki knowledge source
Wiki knowledge source structure
Export
Report
General
Telephony
Debugging for AI Microservice 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 \
--header 'Authorization: Bearer <token>'{
"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
JWT-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
Successful operation
Tag object with intent candidates inside Tag object
Anzeigen untergeordnete attribute
Anzeigen untergeordnete attribute
Internal id, e.g. 123
123
e.g. "Complaint"
"Complaint"
The full name when not shown in a tree
"Second Level: Complaint"
The id of the parent tag. null if on root level. Can be created to create the tree structure of tags
6
To what this tag can be assigned to
ticket, contract, customer "ticket"
Type of the tag
skill, product, brand, customerProperty, contractProperty, other "skill"
Visibility of the tag
public, private, disabled "public"
Color of the tag. Default is grey
grey, green, red, blue, yellow, purple, orange, teal "grey"
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
"moderate"
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.
8
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 "do-not-change"
Channels for which this tag can be detected. If empty or null, then this tag can be assigned to all channels.
["email", "chat"]Subchannels (=Mailboxes/Chat channels) for which this tag can be detected. If empty or null, then this tag can be assigned to all subchannels.
[2, 4]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 ["assignBySubchannel", "assignByCustomLogic"]Test case for the tag
The user that last modified the tag
"John Doe"
The date and time when the tag was last modified
"2024-08-29 14:38:12"
Anzeigen untergeordnete attribute
Anzeigen untergeordnete attribute
Unique identifier of the AI agent (unsigned integer)
x >= 01
Category of this ai agent
41
Channels this ai agent is available on
["all"]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
"Change bank data (Code)"
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
"Customer wants to change his bank data"
[8, 26]Anzeigen untergeordnete attribute
Anzeigen untergeordnete attribute
Internal id, e.g. 123 Internal id, e.g. 123
123
e.g. "Complaint" e.g. "Complaint"
"Complaint"
The full name when not shown in a tree The full name when not shown in a tree
"Second Level: Complaint"
The id of the parent tag. null if on root level. Can be created to create the tree structure of tags The id of the parent tag. null if on root level. Can be created to create the tree structure of tags
6
To what this tag can be assigned to To what this tag can be assigned to
ticket, contract, customer "ticket"
Type of the tag Type of the tag
skill, product, brand, customerProperty, contractProperty, other "skill"
Visibility of the tag Visibility of the tag
public, private, disabled "public"
Color of the tag. Default is grey Color of the tag. Default is grey
grey, green, red, blue, yellow, purple, orange, teal "grey"
An array of strings that specify special properties. Currently only ['defaultSkill'], if this tag should be assigned if no skill was found 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 The complexity of the tag
"moderate"
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. 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.
8
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) 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 "do-not-change"
Channels for which this tag can be detected. If empty or null, then this tag can be assigned to all channels. Channels for which this tag can be detected. If empty or null, then this tag can be assigned to all channels.
["email", "chat"]Subchannels (=Mailboxes/Chat channels) for which this tag can be detected. If empty or null, then this tag can be assigned to all subchannels. Subchannels (=Mailboxes/Chat channels) for which this tag can be detected. If empty or null, then this tag can be assigned to all subchannels.
[2, 4]Details how the AI agent is detected 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. 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 ["assignBySubchannel", "assignByCustomLogic"]Test case for the tag Test case for the tag
The user that last modified the tag The user that last modified the tag
"John Doe"
The date and time when the tag was last modified The date and time when the tag was last modified
"2024-08-29 14:38:12"
Anzeigen untergeordnete attribute
Anzeigen untergeordnete attribute
Unique identifier of the AI agent (unsigned integer) Unique identifier of the AI agent (unsigned integer)
x >= 01
Category of this ai agent Category of this ai agent
41
Channels this ai agent is available on Channels this ai agent is available on
["all"]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 name of the AI agent visible to the user. It is also used by the LLM to validate if the intent is correctly identified
"Change bank data (Code)"
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 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
"Customer wants to change his bank data"
[8, 26]curl --request GET \
--url https://demo.enneo.ai/api/mind/aiAgents/tree \
--header 'Authorization: Bearer <token>'{
"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": {}
}
]
}
]
}
}