Get chat details

GET /v1/replicas/{replicaUUID}/chats/{chatUUID}

Organization service token & User Organization service token

Retrieve details of a specific chat by UUID.

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.

Responses

200 application/json

Chat details
Hide response attributes Show response attributes object
- success boolean
  
  Default value is true.
- chat object Required
  
  Hide chat attributes Show chat attributes object
  
  uuid string(uuid) Required
  
  The chat UUID.
  
  source string Required
  
  The source of the chat.
  
  Values are discord, telegram, embed, web, or telegram_autopilot.
  
  messageCount integer Required
  
  Total messages in this chat.
  
  replicaReplyCount integer Required
  
  The total number of assistant replies in this chat.
  
  firstMessageAt string(date-time) Required
  
  The timestamp of the first message in the chat.
  
  lastMessageAt string(date-time) Required
  
  The timestamp of the last message in the chat.
  
  lastReplicaReplyAt string(date-time)
  
  The timestamp of the last assistant reply in the chat.
  
  chatName string
  
  The name of the chat. This can be the name of the user or the name of the group.
  
  chatImageURL string
  
  The image URL of the chat. This can be the profile image of the user or the group.
  
  chatType string Required
  
  The type of chat.
  
  Values are individual or group.
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}

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

Response examples (200)

{
  "success": true,
  "chat": {
    "uuid": "8e9309af-baa4-4a85-8c59-c3a2a0c2ad0f",
    "source": "telegram",
    "messageCount": 42,
    "replicaReplyCount": 21,
    "firstMessageAt": "2025-05-27T15:02:44.499744+00:00",
    "lastMessageAt": "2025-05-27T18:45:12.123456+00:00",
    "lastReplicaReplyAt": "2025-05-27T18:30:22.654321+00:00",
    "chatName": "John Doe",
    "chatImageURL": "https://example.com/image.png",
    "chatType": "individual"
  }
}

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