Skip to Content

StartChatSessionRequest

Properties

NameTypeDescriptionNotes
session_typeChatSessionTypeType of chat session to create (AiRagChat or VendorChat)[default to null]
messageStringThe first message to send. Required to start a session.[default to null]
vendor_location_idLongRequired for VendorChat: ID of the vendor location to chat with. This will be validated to ensure the location exists and belongs to an active vendor.[optional] [default to null]
user_typeChatUserTypeFor AiRagChat: Type of user (defaults to Customer if not provided)[optional] [default to null]
initial_contextRagInitialContextDtoFor AiRagChat: Optional initial context including location and preferences[optional] [default to null]
message_typeMessageTypeFor VendorChat: Type of message being sent (defaults to Text)[optional] [default to null]
payloadanyFor VendorChat: Message payload (defaults to {\"text\": message})[optional] [default to null]
client_timestampLongFor VendorChat: Client timestamp in milliseconds[optional] [default to null]
client_temp_idStringFor VendorChat: Optional client-side temporary ID for deduplication[optional] [default to null]

[Back to Model list] [Back to API list] [Back to README]