POST
/
aiAgent
/
{id}
/
preview
curl --request POST \
  --url https://demo.enneo.ai/api/mind/aiAgent/{id}/preview \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "tagId": 41,
  "channels": [
    "all"
  ],
  "name": "Change bank data (Code)",
  "description": "Customer wants to change his bank data",
  "appearance": {},
  "exampleTicketIds": [
    8,
    26
  ],
  "settings": {},
  "previewType": "<string>",
  "message": "<string>",
  "subject": "<string>",
  "sender": "<string>",
  "history": [
    {}
  ]
}'
{
  "success": true,
  "error": null,
  "dataOutcome": {},
  "dataOutcomeInfo": "<string>",
  "customerOutcome": {},
  "customerOutcomeType": "<string>",
  "customerOutcomeInfo": "<string>",
  "curlRequests": {}
}

Authorizations

​
connect.sid
string
cookie
required

Cookie-based authentication

Path Parameters

​
id
integer
required

The id of the AI Agent that should be retrieved

Query Parameters

​
ticketId
integer
required

The ticketId for which to tailor the response to. A future release will also support an intent preview without linking it to a ticketId

Body

application/json
The new updated AI agent
​
id
integer

Unique identifier of the AI agent (unsigned integer)

Required range: x >= 0
Example:

1

​
tagId
integer

Category of this ai agent

Example:

41

​
channels
string[]

Channels this ai agent is available on

Example:
["all"]
​
name
string

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

Example:

"Change bank data (Code)"

​
description
string

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

Example:

"Customer wants to change his bank data"

​
appearance
object
​
exampleTicketIds
integer[]
Example:
[8, 26]
​
settings
object
​
previewType
string

The type of preview to use

​
message
string

The message to send to the AI Agent

​
subject
string

The subject of the message

​
sender
string

The sender of the message

​
history
object[]

The history of the message

Response

200 - application/json
Successful operation
​
success
boolean

The outcome of the preview

Example:

true

​
error
string | null

The error message if the preview failed

Example:

null

​
dataOutcome
object

The outcome of the data preview

​
dataOutcomeInfo
string
​
customerOutcome
object

The outcome of the customer preview

​
customerOutcomeType
string
​
customerOutcomeInfo
string
​
curlRequests
object[] | null

The curl requests that would be sent to the backend systems

Example:
{}