Skip to main content
POST
/
api
/
ai-advisor
Chat With Advisor
curl --request POST \
  --url https://api.loyalty.dog/api/ai-advisor \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "<string>",
  "conversationHistory": [
    {
      "role": "<string>",
      "content": "<string>"
    }
  ],
  "dateRangeOverride": {},
  "userId": "<string>",
  "programId": "<string>",
  "transactionSummary": {},
  "transactionDetails": [
    {}
  ],
  "currencyCode": "USD",
  "currencySymbol": "$"
}
'
{
  "response": "<string>",
  "transactionCount": 123,
  "transactionSummary": {},
  "dateRange": {},
  "timestamp": "<string>",
  "warning": "<string>"
}

Authorizations

Authorization
string
header
required

JWT access token obtained from POST /v2/token.

Body

application/json
message
string
required
Required string length: 1 - 2000
conversationHistory
Message · object[]
Maximum array length: 20
dateRangeOverride
Daterangeoverride · object
userId
string | null
programId
string | null
transactionSummary
Transactionsummary · object
transactionDetails
Transactiondetails · object[] | null
Maximum array length: 100
currencyCode
string
default:USD
currencySymbol
string
default:$

Response

Successful Response

response
string
required
transactionCount
integer
required
transactionSummary
Transactionsummary · object
required
dateRange
Daterange · object
required
timestamp
string
required
warning
string | null