Conversations

List threads

Gets a list of conversational threads for an AI Agent. Only the last sent message is shown. To get the full conversation, a separate requests to view the conversations is necessary. Without a date range provided, the list will only contain the last 30 days.

GET/v1/accounts/:accountID/application/:applicationID/ai-agents/:aiAgentID/sessions

curl --request GET \
  --url http://api.sidecarcx.com/v1/accounts/:accountID/application/:applicationID/ai-agents/:aiAgentID/sessions \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Path Parameters

:accountID - REQUIRED[String]
The referenced account ID.
:applicationID - REQUIRED[String]
The referenced application ID.
:aiAgentID - REQUIRED[String]
The referenced AI Agent ID.

Chat History Messages Response - [Map]

A list of chat history messages for an AI agent.

Attributes

chatHistoryMessages - REQUIRED[Array]
The list of chat history messages.
List Contents (chatHistoryMessages)- type of [Map]
- chatHistoryMessages[0].actor - REQUIRED[String]
  The actor who sent the message.
- chatHistoryMessages[0].chatMessageID - REQUIRED[String]
  The chat message identifier.
- chatHistoryMessages[0].chatSessionID - REQUIRED[String]
  The chat session identifier.
- chatHistoryMessages[0].chatUserEmail - OPTIONAL[String]
  The originating chat user email.
- chatHistoryMessages[0].chatUserID - REQUIRED[String]
  The originating chat user ID.
- chatHistoryMessages[0].createdAt - REQUIRED[String]
  The date the message was created.
- chatHistoryMessages[0].message - REQUIRED[String]
  The chat message.
- chatHistoryMessages[0].messageCount - REQUIRED[Integer]
  The number of messages in the session.
- chatHistoryMessages[0].updatedAt - REQUIRED[String]
  The date the message was last updated.
- chatHistoryMessages[0].voteStatus - OPTIONAL[String]
  The vote status of the message, only applies to bot actors.
totalChatHistoryMessages - REQUIRED[Integer]
The total number of chat history messages.

Chat History Messages Response Shape

{
  "chatHistoryMessages": [
    {
      "actor": "string",
      "chatMessageID": "string",
      "chatSessionID": "string",
      "chatUserEmail": "string",
      "chatUserID": "string",
      "createdAt": "string",
      "message": "string",
      "messageCount": 0,
      "updatedAt": "string",
      "voteStatus": "string"
    }
  ],
  "totalChatHistoryMessages": 0
}

Errors

A common set of Error Responses can be found here.