Zum Hauptinhalt springen
GET
/
aiAgents
List of all available AI agents as an array
curl --request GET \
  --url https://demo.enneo.ai/api/mind/aiAgents \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 1,
    "tagId": 41,
    "channels": [
      "all"
    ],
    "name": "Change bank data (Code)",
    "description": "Customer wants to change his bank data",
    "appearance": {},
    "exampleTicketIds": [
      8,
      26
    ],
    "settings": {}
  }
]

Autorisierungen

​
Authorization
string
header
erforderlich

JWT-based authentication

Abfrageparameter

​
limit
integer
Standard:100

The number of items to return

Erforderlicher Bereich: 1 <= x <= 1000
​
offset
integer
Standard:0

The number of items to skip

Erforderlicher Bereich: x >= 0
​
categoryFilter
enum<string>

Filter criteria based on category. If ommited, only ai agents will be returned ("intent")

Verfügbare Optionen:
all,
intent,
template
​
typeFilter
enum<string>

Filter criteria based on type of the executor. If ommited, all types are returned.

Verfügbare Optionen:
sourceCode,
apiCall,
visualEditor
​
format
enum<string>

Output format. Either short (only name/id), medium (key facts) or full (all details). Defaults to full.

Verfügbare Optionen:
short,
medium,
full
​
q
string

Search query for fulltext search in name and description fields. Results are ordered by relevance when search is used

Antwort

Successful operation

​
id
integer<int32>

Unique identifier of the AI agent (unsigned integer)

Erforderlicher Bereich: x >= 0
Beispiel:

1

​
tagId
integer

Category of this ai agent

Beispiel:

41

​
channels
string[]

Channels this ai agent is available on

Beispiel:
["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

Beispiel:

"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

Beispiel:

"Customer wants to change his bank data"

​
appearance
object
​
exampleTicketIds
integer[]
Beispiel:
[8, 26]
​
settings
object