List messages in a chat conversation

GET /v1/replicas/{replicaUUID}/chats/{chatUUID}/conversations/{conversationUUID}/messages

Organization service token & User Organization service token

Retrieves messages in a specific conversation within a chat with cursor-based pagination. Messages are sorted chronologically from oldest to newest.

Use the beforeUUID parameter to get older messages and the afterUUID parameter to get newer messages. Please note:

When beforeUUID is specified, the most recent messages before beforeUUID are returned.
When beforeUUID and afterUUID are both specified, the most recent messages before beforeUUID are returned.
When afterUUID is specified on its own, the least recent messages after afterUUID are returned.

Headers

X-API-Version string

Default value is 2025-03-25.

Path parameters

replicaUUID string(uuid) Required

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

The chat UUID.
conversationUUID string(uuid) Required

The conversation UUID.

Query parameters

limit number

The number of messages to fetch.

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

Only show messages after given message UUID. Excludes given message UUID.
beforeUUID string(uuid)

Only show messages before given message UUID. Excludes given message UUID.

Responses

200 application/json

List of messages in the chat conversation
Hide response attributes Show response attributes object
- success boolean Required
  
  Indicates the status of the request
- items array[object] Required
  
  Hide items attributes Show items 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)
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
- error_code string
  
  A machine-readable error code indicating the specific error condition. Used for programmatic error handling
- 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
- error_code string
  
  A machine-readable error code indicating the specific error condition. Used for programmatic error handling
- 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
- error_code string
  
  A machine-readable error code indicating the specific error condition. Used for programmatic error handling
- 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
- error_code string
  
  A machine-readable error code indicating the specific error condition. Used for programmatic error handling
- 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}/chats/{chatUUID}/conversations/{conversationUUID}/messages

curl \
 --request GET 'https://api.sensay.io/v1/replicas/03db5651-cb61-4bdf-9ef0-89561f7c9c53/chats/8e9309af-baa4-4a85-8c59-c3a2a0c2ad0f/conversations/8e9309af-baa4-4a85-8c59-c3a2a0c2ad0f/messages' \
 --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": [
    {
      "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"
    }
  ]
}

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"
  }
}