List mentions in a conversation

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

Organization service token & User Organization service token

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.

Headers

X-API-Version string

Default value is 2025-03-25.

Path parameters

replicaUUID string(uuid) Required

The replica unique identifier (UUID)
conversationUUID string(uuid) Required

The conversation unique identifier (UUID)

Query parameters

limit number

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

Minimum value is 1, maximum value is 100. Default value is 20.
afterUUID string(uuid)

Only returns results after the given message UUID. Excludes given message UUID.
beforeUUID string(uuid)

Only returns results before the given message UUID. Excludes given message UUID.
minimumMessagesInPlaceholder number | null

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

Default value is 3.

Responses

200 application/json

List of messages/placeholders
Hide response attributes Show response attributes object
- success boolean Required
  
  Indicates the status of the request
- items array[object] Required
  
  Any of:
  Messages object Placeholder object
  
  A group of messages around a mention.
  
  Hide attributes Show attributes
  
  type string Required
  
  Value is mention.
  
  messages array[object] Required
  
  A message in a conversation.
  
  Hide messages attributes Show messages attributes object
  
  uuid string(uuid) Required
  
  The UUID of the message.
  
  createdAt string(date-time) Required
  
  The date and time the message was created.
  
  content string Required
  
  The content of the message.
  
  role string Required
  
  The role of the message sender.
  
  Values are user or assistant.
  
  senderName string
  
  The name of the message sender, if available.
  
  senderProfileImageURL string
  
  The avatar URL of the message sender, if available.
  
  source string Required
  
  The source of the message.
  
  Values are discord, telegram, embed, web, or telegram_autopilot.
  
  replicaUUID string(uuid) Required
  
  The replica unique identifier (UUID)
  
  A placeholder, indicating that there are messages that can be loaded in its place.
  
  Hide attributes Show attributes
  
  type string Required
  
  Value is placeholder.
  
  count number Required
  
  The number of messages collapsed into this placeholder
- hasMore boolean Required
  
  Whether there are more items available beyond the current page
400 application/json

Bad Request
Hide response attributes Show response attributes object
- success boolean Required
  
  Indicates the status of the request
- error string Required
  
  A text representation of the error
- fingerprint string
  
  A unique identifier of the event, useful for reporting
- request_id string Required
  
  A unique identifier of the request, useful for reporting
401 application/json

Unauthorized
Hide response attributes Show response attributes object
- success boolean Required
  
  Indicates the status of the request
- error string Required
  
  A text representation of the error
- fingerprint string
  
  A unique identifier of the event, useful for reporting
- request_id string Required
  
  A unique identifier of the request, useful for reporting
404 application/json

Not Found
Hide response attributes Show response attributes object
- success boolean Required
  
  Indicates the status of the request
- error string Required
  
  A text representation of the error
- fingerprint string
  
  A unique identifier of the event, useful for reporting
- request_id string Required
  
  A unique identifier of the request, useful for reporting
415 application/json

Unsupported Media Type
Hide response attributes Show response attributes object
- success boolean Required
  
  Indicates the status of the request
- error string Required
  
  A text representation of the error
- fingerprint string
  
  A unique identifier of the event, useful for reporting
- request_id string Required
  
  A unique identifier of the request, useful for reporting
500 application/json

Internal Server Error
Hide response attributes Show response attributes object
- success boolean Required
  
  Indicates the status of the request
- error string Required
  
  A text representation of the error
- fingerprint string
  
  A unique identifier of the event, useful for reporting
- request_id string Required
  
  A unique identifier of the request, useful for reporting
- inner_exception object
  
  The inner exception
  
  Hide inner_exception attributes Show inner_exception attributes object
  
  name string Required
  
  message string Required
  
  cause string
  
  stack string

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

curl \
 --request GET 'https://api.sensay.io/v1/replicas/03db5651-cb61-4bdf-9ef0-89561f7c9c53/conversations/4e162bcb-2a32-4b35-89bf-7cf729a73687/mentions' \
 --header "X-ORGANIZATION-SECRET: $API_KEY" \
 --header "X-USER-ID: $API_KEY" \
 --header "X-API-Version: 2025-03-25"

Response examples (200)

{
  "success": true,
  "items": [
    {
      "type": "mention",
      "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
}

Response examples (400)

{
  "error": "A text representation of the error",
  "success": false,
  "request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
  "fingerprint": "14fceadd84e74ec499afe9b0f7952d6b"
}

Response examples (401)

{
  "error": "A text representation of the error",
  "success": false,
  "request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
  "fingerprint": "14fceadd84e74ec499afe9b0f7952d6b"
}

Response examples (404)

{
  "error": "A text representation of the error",
  "success": false,
  "request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
  "fingerprint": "14fceadd84e74ec499afe9b0f7952d6b"
}

Response examples (415)

{
  "error": "A text representation of the error",
  "success": false,
  "request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
  "fingerprint": "14fceadd84e74ec499afe9b0f7952d6b"
}

Response examples (500)

{
  "error": "A text representation of the error",
  "success": false,
  "request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
  "fingerprint": "14fceadd84e74ec499afe9b0f7952d6b",
  "inner_exception": {
    "name": "Server overheated",
    "cause": "Request too complicated",
    "stack": "Error: Server overheated due to an unexpected situation\n    at Object.eval (eval at <anonymous>...",
    "message": "The server overheated due to an unexpected situation"
  }
}