Get Chatbot Response
Return a chatbot response given prompt and previous turns.
Stores the new turn in the history for the chatId
NsApiSlow threshold: 2000 ms.
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Body
ChatId, IsoLangCode, UserPrompt, DisplayValue, PreviousTurns, ApiUrl
Response
OK
Chat turn contains one user question, an optional display value for the user prompt, and one chatbot response. Carrier object for ChatbotTurn. Services for the ChatbotTurn Carrier is available from the AI Agent.
UTC timestamp for turn - when response was generated.
Text from the user
Optional display value to use instead of the the UserPrompt
Text from the chatbot
optional dictionary of action buttons. Key = Display text, Value = Prompt text
optional array of attachments - can be URL or Base64 encoded data
Related topics
Get Chatbot TurnsGet Chatbot Prompt SuggestionsNSChatSessionEntityGet Connection Startup ResponseNSApproveRejectResponsechatbot