Enneo

AiAgent

Update an existing AI Agent

PATCH /aiAgent/{id}

PATCH /aiAgent/{id}

Path parameters

idstringpathrequired

The unique identificator of the AI Agent

Request body

The new updated AI agent

idintegerbody

Unique identifier of the AI agent (unsigned integer)

tagIdintegerbody

Category of this ai agent

channelsstring[]body

Channels this ai agent is available on

namestringbody

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

descriptionstringbody

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

appearanceobjectbody

No description.

exampleTicketIdsinteger[]body

No description.

settingsobjectbody

No description.

Request Example

{
  "id": 1,
  "tagId": 41,
  "channels": [
    "all"
  ],
  "name": "Change bank data (Code)",
  "description": "Customer wants to change his bank data",
  "appearance": null,
  "exampleTicketIds": [
    8,
    26
  ],
  "settings": null
}

Responses

200 — Intent description updated

Response Example

{
  "success": true
}

403 — Unauthorized

404 — Intent description not found

422 — AI agent definition contains invalid parameter references

500 — Internal error