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
Get settings of a client in a grouped way for a category
curl --request GET \
--url https://demo.enneo.ai/api/mind/settings/category/{category} \
--header 'Authorization: Bearer <token>'{
"title": "E-Mail Settings",
"groups": [
{
"name": "Generic E-Mail Settings",
"description": "You can configure your general email settings here",
"settings": [
{
"name": "ticketingSystem",
"category": "email",
"group": "Generic E-Mail Settings",
"label": "Ticketing system in use",
"description": "Enneo supports multiple ticketing systems. Please select one.",
"type": "select",
"config": null,
"value": "internal",
"defaultValue": "internal"
}
]
}
]
}Authorizations
JWT-based authentication
Path Parameters
Filter by category of the setting
Response
List of client-specific configruation settings.
"E-Mail Settings"
Show child attributes
Show child attributes
"Generic E-Mail Settings"
"You can configure your general email settings here"
Show child attributes
Show child attributes
"ticketingSystem"
"email"
"Generic E-Mail Settings"
"Ticketing system in use"
"Enneo supports multiple ticketing systems. Please select one."
Format in which the FE should render this setting. Follows the enneo standard dynamic intent form options specified in Notion
text, date, radio, number, integer, checkbox, textarea, select, json, executor, executors, multiselect "select"
Additional configuration properties that are dependant on type or rarely used
Show child attributes
Show child attributes
If type is 'select', then this lists the dropdown options available to the user
Information that the FE should render this field as a readonly
false
Information that this is sensitive information. Value will only be returned if the user has sufficient permissions, and if the query parameter showSecrets=true was provided
false
"internal"
"internal"
curl --request GET \
--url https://demo.enneo.ai/api/mind/settings/category/{category} \
--header 'Authorization: Bearer <token>'{
"title": "E-Mail Settings",
"groups": [
{
"name": "Generic E-Mail Settings",
"description": "You can configure your general email settings here",
"settings": [
{
"name": "ticketingSystem",
"category": "email",
"group": "Generic E-Mail Settings",
"label": "Ticketing system in use",
"description": "Enneo supports multiple ticketing systems. Please select one.",
"type": "select",
"config": null,
"value": "internal",
"defaultValue": "internal"
}
]
}
]
}