LOloyalty
AI Advisor

Chat With Advisor

Changed on

Handle a chat request and return a structured AI advisor response.

Uses Mistral AI with the Scout personality to provide business insights.

Returns: AIAdvisorResponse: Advisor message, transaction metrics and summary, date range, optional warning, and timestamp.

Raises: HTTPException: with status 503 if AI backend (MISTRAL_API_KEY) is not configured; with status 500 for other internal errors.

post/api/ai-advisor

Request

Headers

authorizationstring nullable

Request body

messagestring required
dateRangeOverrideobject nullable
userIdstring nullable
programIdstring nullable
transactionSummaryobject nullable
transactionDetailsobject[] nullable
currencyCodestring
currencySymbolstring

Response

Successful Response

responsestring required
transactionCountinteger required
transactionSummaryobject required
dateRangeobject required
warningstring nullable
timestampstring required

Changes