Conversations

List mentions in a conversation

Retrieves mentions of a replica in a specific conversation, together with context surrounding the mention. This endpoint supports cursor-based pagination. Returns most recent mentions first.

get/v1/replicas/{replicaUUID}/conversations/{conversationUUID}/mentions

Request

Base URL: https://api.sensay.io
URL: https://api.sensay.io/v1/replicas/{replicaUUID}/conversations/{conversationUUID}/mentions
Auth: one of:
- API key in header X-ORGANIZATION-SECRET and API key in header X-USER-ID and API key in header X-USER-ID-TYPE
- API key in header X-ORGANIZATION-SECRET

Path parameters

replicaUUIDstring uuid required

The replica unique identifier (UUID)

Example:03db5651-cb61-4bdf-9ef0-89561f7c9c53

conversationUUIDstring uuid required

The conversation unique identifier (UUID)

Example:4e162bcb-2a32-4b35-89bf-7cf729a73687

Query parameters

limitnumber

The number of items to fetch. A group of messages is counted as 1 item and a placeholder is counted as 1 item.

Example:10

afterUUIDstring uuid

Only returns results after the given message UUID. Excludes given message UUID.

Example:40d353f3-1241-449e-9fa6-c798d62c9cb1

beforeUUIDstring uuid

Only returns results before the given message UUID. Excludes given message UUID.

Example:ec46b4db-3f0d-4392-b0f5-9fe327922e8a

minimumMessagesInPlaceholdernumber nullable

The minimum number of messages to include in the placeholder. Placeholders with less than this number of messages will be expanded into messages.

Example:3

Headers

X-API-Versionstring

Example:2025-03-25

Response

List of messages/placeholders

successboolean required

Indicates the status of the request

hasMoreboolean required

Whether there are more items available beyond the current page

Example response

{
  "items": [
    {
      "messages": [
        {
          "uuid": "03db5651-cb61-4bdf-9ef0-89561f7c9c53",
          "createdAt": "2024-09-24T09:09:55.66709+00:00",
          "content": "Hello world!",
          "role": "user",
          "senderName": "John Doe",
          "senderProfileImageURL": "https://example.com/avatar.png",
          "source": "web",
          "replicaUUID": "03db5651-cb61-4bdf-9ef0-89561f7c9c53"
        }
      ]
    }
  ],
  "hasMore": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.