API Documentation
Chatbot Appearance
Chatbot Custom Content
Chatbot Follow Up Prompts
Chatbot Icons
Chatbot Links
Chatbot Messages
Chatbot Personas
Chatbot Prompts
Chatbot Quick Prompts
Chatbot Settings
Chatbot Threads
Chatbot Threads
Fetch Thread
Fetch a single thread of the chatbot
GET
/
v0
/
chatbots
/
{chatbotId}
/
threads
/
{threadId}
curl --request GET \
--url https://sitegpt.ai/api/v0/chatbots/{chatbotId}/threads/{threadId} \
--header 'Authorization: Bearer <token>'
{
"success": true,
"message": "Fetched the thread successfully",
"data": {
"thread": {
"threadId": "06b3b43c-5651-49a2-b618-d7f24667c1b6",
"mode": "AI",
"messages": [
{
"messageId": "365062948587045457",
"question": {
"text": "Hello, what is this?",
"timestamp": "2023-05-18T11:40:07.857030Z"
},
"answer": {
"text": "Hello! I am an AI assistant designed to provide information about the website's content. If you have any specific questions, feel free to ask and I will do my best to provide accurate answers.",
"timestamp": "2023-05-18T11:40:07.857030Z"
},
"reaction": "NEUTRAL",
"sources": [],
"messageType": "NORMAL_MESSAGE",
"systemMessageType": "CONVERSATION_ESCALATED",
"iconUrl": null,
"prompts": [],
"gptModel": "gpt-3.5-turbo"
},
{
"messageId": "365064286366597712",
"question": {
"text": "Hi",
"timestamp": "2023-05-18T12:01:23.667033Z"
},
"answer": null,
"reaction": "NEUTRAL",
"sources": [],
"messageType": "USER_MESSAGE",
"systemMessageType": "CONVERSATION_ESCALATED",
"iconUrl": null,
"prompts": [],
"gptModel": "gpt-3.5-turbo"
},
{
"messageId": "365064310572974672",
"question": null,
"answer": {
"text": "YO",
"timestamp": "2023-05-18T12:01:46.751791Z"
},
"reaction": "NEUTRAL",
"sources": [],
"messageType": "AGENT_MESSAGE",
"systemMessageType": "CONVERSATION_ESCALATED",
"iconUrl": null,
"prompts": [],
"gptModel": "gpt-3.5-turbo"
}
],
"startedAt": "2023-05-18T11:39:57.349750Z",
"updatedAt": "2023-05-18T11:39:57.349750Z",
"webhookUrl": "https://hooks.zapier.com/hooks/catch/15695697/3hqs23e",
"totalMessagesRead": 47,
"chatUserId": null,
"chatbotId": "365062873485935184",
"chatUser": null
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Id of the chatbot
Id of the chatbot thread
Query Parameters
Parameter to identify if messages needs to be returned or not
Parameter to identify if chat user details needs to be returned or not
Response
200
application/json
OK
Success Response
Was this page helpful?
curl --request GET \
--url https://sitegpt.ai/api/v0/chatbots/{chatbotId}/threads/{threadId} \
--header 'Authorization: Bearer <token>'
{
"success": true,
"message": "Fetched the thread successfully",
"data": {
"thread": {
"threadId": "06b3b43c-5651-49a2-b618-d7f24667c1b6",
"mode": "AI",
"messages": [
{
"messageId": "365062948587045457",
"question": {
"text": "Hello, what is this?",
"timestamp": "2023-05-18T11:40:07.857030Z"
},
"answer": {
"text": "Hello! I am an AI assistant designed to provide information about the website's content. If you have any specific questions, feel free to ask and I will do my best to provide accurate answers.",
"timestamp": "2023-05-18T11:40:07.857030Z"
},
"reaction": "NEUTRAL",
"sources": [],
"messageType": "NORMAL_MESSAGE",
"systemMessageType": "CONVERSATION_ESCALATED",
"iconUrl": null,
"prompts": [],
"gptModel": "gpt-3.5-turbo"
},
{
"messageId": "365064286366597712",
"question": {
"text": "Hi",
"timestamp": "2023-05-18T12:01:23.667033Z"
},
"answer": null,
"reaction": "NEUTRAL",
"sources": [],
"messageType": "USER_MESSAGE",
"systemMessageType": "CONVERSATION_ESCALATED",
"iconUrl": null,
"prompts": [],
"gptModel": "gpt-3.5-turbo"
},
{
"messageId": "365064310572974672",
"question": null,
"answer": {
"text": "YO",
"timestamp": "2023-05-18T12:01:46.751791Z"
},
"reaction": "NEUTRAL",
"sources": [],
"messageType": "AGENT_MESSAGE",
"systemMessageType": "CONVERSATION_ESCALATED",
"iconUrl": null,
"prompts": [],
"gptModel": "gpt-3.5-turbo"
}
],
"startedAt": "2023-05-18T11:39:57.349750Z",
"updatedAt": "2023-05-18T11:39:57.349750Z",
"webhookUrl": "https://hooks.zapier.com/hooks/catch/15695697/3hqs23e",
"totalMessagesRead": 47,
"chatUserId": null,
"chatbotId": "365062873485935184",
"chatUser": null
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.