sitegpt-ai · Schema

Thread

Chatbot Thread

CompanyArtificial IntelligenceCustomer ServiceChatbotsSoftware-as-a-ServiceAutomation

Properties

Name Type Description
threadId string Id of the chatbot thread
chatbotId string Id of the chatbot
chatUserId stringnull Id of the user chatting in the thread
mode object Mode of the thread
startedAt string Timestamp indicating when the thread has been started
updatedAt string Timestamp indicating when the thread has been last updated
endedAt string Timestamp indicating when the thread has been ended
escalated boolean Indicates whether conversation has been escalated or not
webhookUrl stringnull All messages are sent to this webhook url
webhookToken stringnull The token which is sent in header in the calls made to the above webhook url for all messages
messages array Messages of the thread
totalMessagesRead integer Number of messages that are read in this thread
chatUser object
View JSON Schema on GitHub

JSON Schema

sitegpt-ai-thread-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-thread-schema.json",
  "title": "Thread",
  "description": "Chatbot Thread",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/sitegpt-ai-chatbot-threads-api-openapi.yml#/components/schemas/Thread",
  "type": "object",
  "properties": {
    "threadId": {
      "type": "string",
      "description": "Id of the chatbot thread"
    },
    "chatbotId": {
      "type": "string",
      "description": "Id of the chatbot"
    },
    "chatUserId": {
      "type": [
        "string",
        "null"
      ],
      "description": "Id of the user chatting in the thread"
    },
    "mode": {
      "enum": [
        "AI",
        "AGENT"
      ],
      "description": "Mode of the thread"
    },
    "startedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp indicating when the thread has been started"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp indicating when the thread has been last updated"
    },
    "endedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp indicating when the thread has been ended"
    },
    "escalated": {
      "type": "boolean",
      "description": "Indicates whether conversation has been escalated or not"
    },
    "webhookUrl": {
      "type": [
        "string",
        "null"
      ],
      "description": "All messages are sent to this webhook url"
    },
    "webhookToken": {
      "type": [
        "string",
        "null"
      ],
      "description": "The token which is sent in header in the calls made to the above webhook url for all messages"
    },
    "messages": {
      "type": "array",
      "description": "Messages of the thread",
      "items": {
        "$ref": "#/$defs/ThreadMessage"
      }
    },
    "totalMessagesRead": {
      "type": "integer",
      "description": "Number of messages that are read in this thread"
    },
    "chatUser": {
      "$ref": "#/$defs/ChatUser"
    }
  },
  "$defs": {
    "ChatQuestionAnswer": {
      "title": "Chat-Question-Answer",
      "type": [
        "object",
        "null"
      ],
      "description": "Model for question/answer in the chat",
      "properties": {
        "text": {
          "type": "string",
          "description": "Text containing either question or the answer"
        },
        "timestamp": {
          "type": "string",
          "format": "date-time",
          "description": "Timestamp of the question asked or answer replied"
        }
      }
    },
    "ChatUser": {
      "title": "Chat-User",
      "type": [
        "object",
        "null"
      ],
      "description": "Chat User",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the user"
        },
        "name": {
          "type": "string",
          "description": "Name of the user"
        },
        "email": {
          "type": "string",
          "format": "email",
          "description": "Email Id of the user"
        },
        "phone": {
          "type": "string",
          "description": "Phone Number of the user"
        },
        "verified": {
          "type": "boolean",
          "description": "Indicates whether the user is verified or not"
        },
        "createdAt": {
          "type": "string",
          "format": "date-time",
          "description": "Timestamp indicating when the user is created"
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time",
          "description": "Timestamp indicating when the user is last updated"
        }
      }
    },
    "MessageReaction": {
      "title": "Message-Reaction",
      "description": "User's reaction to the message",
      "enum": [
        "POSITIVE",
        "NEGATIVE",
        "NEUTRAL"
      ]
    },
    "MessageType": {
      "title": "Message-Type",
      "description": "Type of the message in the thread",
      "enum": [
        "NORMAL_MESSAGE",
        "USER_MESSAGE",
        "AGENT_MESSAGE",
        "SYSTEM_MESSAGE"
      ]
    },
    "QuickPrompt": {
      "type": "object",
      "description": "Chatbot Conversation Starter",
      "properties": {
        "id": {
          "type": "string",
          "description": "Id of the conversation-starter"
        },
        "title": {
          "type": "string",
          "description": "Title of the conversation-starter. This is the text that is shown as button in the chatbot."
        },
        "link": {
          "type": [
            "string",
            "null"
          ],
          "description": "Link of the conversation starter. If this link is not null, then when you click on the conversation starter in the chatbot, this link will be opened instead of sending a message to the chatbot."
        },
        "description": {
          "type": "string",
          "description": "Description of the conversation-starter. This is the message that will be sent to the chatbot when you click on the conversation-starter inside the chatbot."
        }
      }
    },
    "SystemMessageType": {
      "title": "System-Message-Type",
      "description": "Type of the message if type of the message is SYSTEM_MESSAGE",
      "enum": [
        "CONVERSATION_ESCALATED",
        "EXCEEDED_USAGE_LIMITS",
        "EMAIL_VERIFIED",
        "ENTERED_WRONG_OTP",
        "PROVIDED_EMAIL",
        "PERSONA_SELECTED",
        "PROBLEMS_WITH_UPSTREAM_PROVIDER",
        "COLLECT_LEAD",
        "CONVERSATION_SWITCHED_TO_AI",
        "MODERATION_FLAGGED",
        "HUMAN_SUPPORT_CONFIRMATION",
        "HUMAN_TOOK_OVER",
        "AWAY_MESSAGE"
      ]
    },
    "ThreadMessage": {
      "title": "Thread-Message",
      "type": "object",
      "description": "Message of a thread",
      "properties": {
        "messageId": {
          "type": "string",
          "description": "Id of the message"
        },
        "messageType": {
          "$ref": "#/$defs/MessageType"
        },
        "systemMessageType": {
          "$ref": "#/$defs/SystemMessageType"
        },
        "question": {
          "$ref": "#/$defs/ChatQuestionAnswer"
        },
        "answer": {
          "$ref": "#/$defs/ChatQuestionAnswer"
        },
        "reaction": {
          "$ref": "#/$defs/MessageReaction"
        },
        "sources": {
          "type": "array",
          "description": "Sources used to answer the question",
          "items": {
            "type": "string"
          }
        },
        "escalated": {
          "type": "boolean",
          "description": "Indicates whether this message is escalated or not"
        },
        "iconUrl": {
          "type": [
            "string",
            "null"
          ],
          "description": "Url of the icon used in this message"
        },
        "prompts": {
          "type": [
            "array",
            "null"
          ],
          "description": "Quick prompts that have been configured by chatbot owner",
          "items": {
            "$ref": "#/$defs/QuickPrompt"
          }
        },
        "gptModel": {
          "type": "string",
          "description": "GPT Model used to answer the question"
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/sitegpt-ai-thread"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.