v1

latestOpenAPI 3.0.3FortiCNAPP Use License2026-08-041754351.1 MB

AlertAiAssistant

Start Alert AI Assistant thread

Generate the first alert-focused response for a request scoped to a specific alert. This compatibility path remains /api/v2/AiAssistants/start, but the request payload is alert-specific and requires providerConfig plus alert context in conversationContext. Provide either conversationContext.metaInstructions with an alert reference such as {alertId:12345}, or provide one or more conversationContext.entityPayloads. Requests that provide neither are rejected.

post/api/v2/AiAssistants/start

Headers

Authorizationstring required

Bearer Access Token. For example, "Bearer {YourAPIToken}"

Content-Typestring required

application/json

Org-Accessboolean

Use this attribute to specify if the access token has organization admin permissions. If the access token has only account permissions, use the Account-Name attribute to specify which account to access.

Account-Namestring

Use this attribute to specify which sub-account to access.

Request body

assistantTypestring

Optional compatibility field for the existing public route. If supplied, the only supported value is general.

Example request

{
  "conversationContext": {
    "metaInstructions": "User is asking about this alert? {alertId:12345}",
    "entityPayloads": [
      {
        "entityKey": "Alert",
        "entityIdentifier": "12345",
        "payloadType": "alert",
        "data": {
          "alertId": 12345
        }
      }
    ]
  }
}

Response

No Error (AI Assistants start thread)