Skip to main content
GET
/
api
/
v2
/
ai-suggestions
List AI Suggestions
curl --request GET \
  --url https://app.livechatai.com/api/v2/ai-suggestions \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "data": {
    "agentId": "clx1234567890abcdef",
    "suggestions": [
      {
        "id": "msg_abc123def456",
        "userMessage": {
          "id": "msg_user789xyz",
          "text": "What is the warranty period for your products?"
        },
        "aiMessage": {
          "id": "msg_abc123def456",
          "text": "I'm sorry, I don't have information about that."
        },
        "evaluationTag": "OUT_OF_CONTEXT",
        "potentialGap": "Warranty information is missing from the knowledge base",
        "suggestedImprovement": "All our products come with a 2-year warranty. For details...",
        "chatId": "chat_xyz789",
        "createdAt": "2024-01-15T10:30:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 10,
      "totalCount": 25,
      "totalPages": 3,
      "hasNextPage": true,
      "hasPreviousPage": false
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

agentId
string
required

The unique identifier of the agent (chatbot)

Example:

"clx1234567890abcdef"

page
integer
default:1

Page number for pagination

Required range: x >= 1
limit
integer
default:10

Number of items per page (max 100)

Required range: 1 <= x <= 100
startDate
string<date-time>

Filter suggestions created after this date (ISO 8601 format)

Example:

"2024-01-01T00:00:00Z"

endDate
string<date-time>

Filter suggestions created before this date (ISO 8601 format)

Example:

"2024-12-31T23:59:59Z"

Response

Successfully retrieved AI suggestions

status
string
Example:

"success"

data
object