Create Thread - SiteGPT Docs

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

chatbotId

string

required

Id of the chatbot

Body

application/json

chatUserEmail

string | null

Email of the user that is going to chat in the thread.

mode

enum<string>

Mode of the chat

Available options:

AI,

AGENT

threadId

string | null

If you pass the threadId, new thread will be created with this threadId. Otherwise, random threadId will be generated.

Response

200 - application/json

data

object

Data returned from the server

data.thread

object

Chatbot Thread

data.thread.chatbotId

string

Id of the chatbot

data.thread.chatUser

object | null

Chat User

data.thread.chatUserId

string | null

Id of the user chatting in the thread

data.thread.endedAt

string

Timestamp indicating when the thread has been ended

data.thread.escalated

boolean

Indicates whether conversation has been escalated or not

data.thread.messages

object[]

Messages of the thread

data.thread.messages.answer

object | null

Model for question/answer in the chat

data.thread.messages.escalated

boolean

Indicates whether this message is escalated or not

data.thread.messages.gptModel

string

GPT Model used to answer the question

data.thread.messages.iconUrl

string | null

Url of the icon used in this message

data.thread.messages.messageId

string

Id of the message

data.thread.messages.messageType

enum<string>

Type of the message in the thread

Available options:

NORMAL_MESSAGE,

USER_MESSAGE,

AGENT_MESSAGE,

SYSTEM_MESSAGE

data.thread.messages.prompts

object[] | null

Quick prompts that have been configured by chatbot owner

data.thread.messages.question

object | null

Model for question/answer in the chat

data.thread.messages.reaction

enum<string>

User's reaction to the message

Available options:

POSITIVE,

NEGATIVE,

NEUTRAL

data.thread.messages.sources

string[]

Sources used to answer the question

data.thread.messages.systemMessageType

enum<string>

Type of the message if type of the message is SYSTEM_MESSAGE

Available options:

CONVERSATION_ESCALATED,

EXCEEDED_USAGE_LIMITS,

EMAIL_VERIFIED,

ENTERED_WRONG_OTP,

PROVIDED_EMAIL,

PERSONA_SELECTED,

PROBLEMS_WITH_UPSTREAM_PROVIDER

data.thread.mode

enum<string>

Mode of the thread

Available options:

AI,

AGENT

data.thread.startedAt

string

Timestamp indicating when the thread has been started

data.thread.threadId

string

Id of the chatbot thread

data.thread.totalMessagesRead

integer

Number of messages that are read in this thread

data.thread.updatedAt

string

Timestamp indicating when the thread has been last updated

data.thread.webhookToken

string | null

The token which is sent in header in the calls made to the above webhook url for all messages

data.thread.webhookUrl

string | null

All messages are sent to this webhook url

message

string

Overall message regarding the operation performed

success

boolean

Indicates whether this is success response or error response