Conversations

Get conversation details

Retrieve details for a specific conversation within a replica.

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

Request

Base URL: https://api.sensay.io
URL: https://api.sensay.io/v1/replicas/{replicaUUID}/conversations/{conversationUUID}
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 UUID.

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

Headers

X-API-Versionstring

Example:2025-03-25

Response

Conversation details

uuidstring uuid required

The conversation UUID.

chatUUIDstring uuid required

The chat UUID to which this conversation belongs.

source'discord' | 'telegram' | 'embed' | 'web' | 'telegram_autopilot' required

The source of the conversation.

messageCountnumber required

The total number of messages in the conversation.

replicaReplyCountnumber required

The total number of assistant replies in the conversation.

firstMessageAtstring date-time

The timestamp of the first message in the conversation.

lastMessageAtstring date-time

The timestamp of the last message in the conversation.

lastReplicaReplyAtstring date-time

The timestamp of the last assistant reply in the conversation.

conversationNamestring

The name of the conversation. This can be the name of the user or the name of the group.

conversationImageURLstring

The image URL of the conversation. This can be the profile image of the user or the group.

summarystring

A summary of the conversation.

commonQuestionsstring[]

Common questions asked in this conversation.

commonTopicsstring[]

Common topics discussed in this conversation.

conversationType'individual' | 'group' required

The type of conversation.

successtrue required

Indicates the request was successful

Example response

{
  "uuid": "8e9309af-baa4-4a85-8c59-c3a2a0c2ad0f",
  "chatUUID": "550e8400-e29b-41d4-a716-446655440001",
  "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",
  "success": true
}

Changes

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