Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Message details for the agent
The question or message to send to the agent
Example:
"What are your business hours?"
Unique identifier of the agent to message
Example:
"clx1234567890abcdef"
Optional: Unique identifier of an existing conversation
Example:
"chat_1234567890"
Type of message being sent
Available options:
TEXT
, IMAGE
Example:
"TEXT"
Optional: Enable streaming of the response
Example:
false
Optional: Client IP address
Example:
"192.168.1.1"
Optional: Client country code
Example:
"US"
Optional: Format of the AI response (MARKDOWN or PLAIN text)
Available options:
MARKDOWN
, PLAIN
Example:
"MARKDOWN"
Optional: Integration type for the conversation
Available options:
WHATSAPP
, SLACK
Example:
"WHATSAPP"