List replica's conversations

GET /v1/replicas/{replicaUUID}/conversations

Organization service token & User Organization service token

List of replica's conversations with pagination and sorting.

Headers

X-API-Version string

Default value is 2025-03-25.

Path parameters

replicaUUID string(uuid) Required

The replica unique identifier (UUID)

Query parameters

pageSize number | null

The number of items per page.

Minimum value is 0, maximum value is 100. Default value is 24.
page number

The page number.

Minimum value is 1. Default value is 1.
sortBy string

Sort criteria.

Values are replicaReplies, firstMessageAt, or lastReplicaReplyAt. Default value is lastReplicaReplyAt.
sortOrder string

The order of the sort.

Values are asc or desc. Default value is desc.

Responses

200 application/json

List of conversations
Hide response attributes Show response attributes object
- items array[object] Required
  
  Hide items attributes Show items attributes object
  
  uuid string(uuid) Required
  
  The conversation UUID.
  
  source string Required
  
  The source of the conversation.
  
  Values are discord, telegram, embed, web, or telegram_autopilot.
  
  messageCount number Required
  
  The total number of messages in the conversation.
  
  replicaReplyCount number Required
  
  The total number of assistant replies in the conversation.
  
  firstMessageAt string(date-time)
  
  The timestamp of the first message in the conversation.
  
  lastMessageAt string(date-time)
  
  The timestamp of the last message in the conversation.
  
  lastReplicaReplyAt string(date-time)
  
  The timestamp of the last assistant reply in the conversation.
  
  conversationName string
  
  The name of the conversation. This can be the name of the user or the name of the group.
  
  conversationImageURL string
  
  The image URL of the conversation. This can be the profile image of the user or the group.
  
  summary string Required
  
  A summary of the conversation.
  
  commonQuestions array[string] Required
  
  Common questions asked in this conversation.
  
  commonTopics array[string] Required
  
  Common topics discussed in this conversation.
  
  conversationType string Required
  
  The type of conversation.
  
  Values are individual or group.
- total number Required
  
  The total number of conversations for this replica.
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

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

Response examples (200)

{
  "items": [
    {
      "uuid": "8e9309af-baa4-4a85-8c59-c3a2a0c2ad0f",
      "source": "telegram",
      "messageCount": 42,
      "replicaReplyCount": 42,
      "firstMessageAt": "2025-05-27T15:02:44.499744+00:00",
      "lastMessageAt": "2025-05-27T15:02:44.499744+00:00",
      "lastReplicaReplyAt": "2025-05-27T15:02:44.499744+00:00",
      "conversationName": "John Doe",
      "conversationImageURL": "https://example.com/image.png",
      "summary": "Discussion about blockchain technology and its applications in fintech.",
      "commonQuestions": [
        "What is blockchain?",
        "How does DeFi work?",
        "What are smart contracts?"
      ],
      "commonTopics": [
        "blockchain",
        "cryptocurrency",
        "smart contracts",
        "fintech"
      ],
      "conversationType": "individual"
    }
  ],
  "total": 1001
}

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