Chatbot Messages

Send Message

Send message to a particular thread or start a new thread

post/v0/chatbots/{chatbotId}/message

Request

  • Base URL: https://sitegpt.ai/api
  • URL: https://sitegpt.ai/api/v0/chatbots/{chatbotId}/message
  • Auth: HTTP bearer

Path parameters

chatbotIdstring required

Id of the chatbot

Request body

threadIdstring

If provided, message will be sent to the thread with this threadId. Otherwise, message will be sent to a new thread. This is mandatory when from is AGENT.

messagestring required

Actual text containing the message

from'USER' | 'AGENT'

Indicates who all can send messages to the chat threads

iconUrlstring

Icon url to be associated with the message in the conversation thread

agentNamestring

Agent name to be associated with the message in the conversation thread

includeSmartPromptsboolean

Flag to decide whether to return smart followup questions based on the AI response.

Response

OK

successboolean

Indicates whether this is success response or error response

messagestring

Overall message regarding the operation performed

Changes

No recorded changes to this operation across all 1 revision of this API.