Add Message to Chat
Messages
Add Message
Send a user message to a chat and receive the assistant’s reply.
POST
Add Message to Chat
Add a user message to a chat. The assistant processes the message and returns a reply, which may include follow-up suggestions and product recommendations.
Authentication
This request requires your API key in thex-api-key header.
Request
ID of the chat to add the message to.
Optional query parameter.
The user’s message text.
The URL of the page the user is currently viewing. Used to give the assistant page context.
Response
ID of the created message.
ID of the chat the message belongs to.
The message type, for example whether it originated from the user or the assistant.
The message text content.
Optional list of suggested follow-up questions.
Optional list of recommended products.
ISO 8601 timestamp of when the message was created.
To receive the assistant’s streamed response and tool activity in real time, open the Message Events stream for the same
chatId.Examples
Success response
Error response
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.