Chat Session

This endpoint generates an AI response for a query requested by the user in a chat session with the AI chatbot

POST/v1/interact/chat

Query parameters

Body

application/json

Incoming Chat Message Data

interactionIdstring

Optional id of the interaction. If provided, it will merge history of all previous chats, else the system will generate a new one

content*string

Query by a user or Response from the system

chatUserIdstring

Optional id of the chat user. If not given, system will generate a new one automatically

Response

200403

Chat Message Object

Body

application/json

interactionIdstring

ID of the Interaction. Keep this same across multiple chats to maintain history for user chats.

content*string

Response from the system

chatUserIdstring

ID of the chat user. If not given, system will generate one automatically

roleenum

User/Assistant depending if its a user query or a assistant reply

systemuserassistantfunctionlead

creatednumber

Timestamp for message generation

messageIdstring

Unique Id of the message across the interaction

Request

JavaScriptCurlPython

const response = await fetch('/v1/interact/chat?widgetId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "content": "text"
    }),
});
const data = await response.json();

Response

200

{
  "interactionId": "text",
  "content": "text",
  "chatUserId": "text",
  "role": "system",
  "created": 0,
  "messageId": "text"
}