Ticket
- POSTGet next ticket id to work on
- POSTGet a list of tickets
- POSTCreate a ticket
- PATCHUpdate a few tickets at once
- GETGet a ticket (full data)
- 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
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
Quality Management
- GETList quality scorecards
- POSTCreate a new quality scorecard
- GETGet a specific quality scorecard
- DELDelete a quality scorecard
- PATCHUpdate a quality scorecard
- GETList quality assessments
- GETGet a specific quality assessment
- DELDelete a quality assessment
- PATCHUpdate a quality assessment
- GETGet all assessments for a ticket
General
Telephony
Debugging for AI Microservice Cortex
List response templates
Returns the paginated list of response templates that agents can insert into tickets. When no template matches the provided filters the API responds with HTTP 404.
curl --request GET \
--url https://demo.enneo.ai/api/mind/template \
--header 'Authorization: Bearer <token>'{
"success": true,
"templates": [
{
"id": 12,
"tagId": 101,
"emailTemplateId": 5,
"description": "Reminder: please send your meter reading",
"message": "<p>Hallo {{contract.firstName}},</p><p>bitte sende uns den Stand.</p>",
"subject": "Wir benötigen deinen Zählerstand",
"exampleTicketIds": [
8812,
9100
],
"attachments": []
},
{
"id": 13,
"tagId": null,
"emailTemplateId": 5,
"description": "Default closing",
"message": "<p>Vielen Dank für deine Nachricht.</p>",
"subject": null,
"exampleTicketIds": [],
"attachments": [
{
"name": "instructions.pdf",
"url": "https://cdn.example.com/template/instructions.pdf"
}
]
}
]
}Authorizations
JWT-based authentication
Query Parameters
Number of templates to skip before starting to collect the result set.
x >= 0Maximum number of templates to return.
1 <= x <= 500Optional full-text search term applied to description and message fields.
Filter templates that are linked to a specific AI Agent. Acts as a tag filter internally.
Response
Templates found
Show child attributes
Show child attributes
The id of the template
1
The id of the tag that the template belongs to
1
The id of the email template that is used for wrapping
1
The description of the intent template
"Zählerstand erfolgreich hinterlegt"
The template itself
"<p>Wir haben den Zählerstand von {{intent.data.reading}} kWh für den {{formatDateDE intent.data.date}} erfasst und im System hinterlegt.</p>"
The subject of the email for outgoing emails
"Wir brauchen Deine Unterstützung"
The ids of the tickets that are used as examples for the intent template
The merged template
"Wir haben den Zählerstand von 123 kWh für den 01.01.2022 erfasst und im System hinterlegt."
The template itself
"<p>Wir haben den Zählerstand von 123 kWh für den 01.01.2022 erfasst und im System hinterlegt.</p>"
If true, the template is successful
true
true
curl --request GET \
--url https://demo.enneo.ai/api/mind/template \
--header 'Authorization: Bearer <token>'{
"success": true,
"templates": [
{
"id": 12,
"tagId": 101,
"emailTemplateId": 5,
"description": "Reminder: please send your meter reading",
"message": "<p>Hallo {{contract.firstName}},</p><p>bitte sende uns den Stand.</p>",
"subject": "Wir benötigen deinen Zählerstand",
"exampleTicketIds": [
8812,
9100
],
"attachments": []
},
{
"id": 13,
"tagId": null,
"emailTemplateId": 5,
"description": "Default closing",
"message": "<p>Vielen Dank für deine Nachricht.</p>",
"subject": null,
"exampleTicketIds": [],
"attachments": [
{
"name": "instructions.pdf",
"url": "https://cdn.example.com/template/instructions.pdf"
}
]
}
]
}