Maistro Chat Widget

Embed the chat widget in your site via iframe. Pass configuration as query parameters.

Iframe integration

Add an iframe and set its src to the widget URL with query params:

<iframe
  src="https://YOUR_WIDGET_APP/widget.html?agentId=YOUR_AGENT_ID&baseUrl=https://YOUR_API&username=user123"
  width="100%"
  height="600"
  frameborder="0"
  title="Maistro Chat"
></iframe>

Required query params

Props (query parameters)

All options are passed as URL query parameters. Boolean values use true / false.

PropTypeDescription
agentIdstringAgent identifier (provide agentId or label)
labelstringAgent label, alternative to agentId (provide agentId or label)
baseUrlstringAPI base URL
closeRedirectUrlstringRedirect URL on close
teamLabelstringTeam label
usernamestringUser display name (default: guest-user)
tokenRefstringSession token ref (passed as X-Token-Ref header)
languagestringLocale (e.g. tr, en)
typestringAgent type (default: SequentialConversationalRAGAgent)
channelstringChannel identifier
modestringMode (default: internal)
primaryColorstringPrimary accent color
botTitlestringBot display title
botAvatarImgstringBot avatar image URL
bubbleButtonUrlstringCustom bubble button image URL
bubbleButtonWidthstringBubble button width (default: 150px)
bubbleButtonHeightstringBubble button height (default: 150px)
bubbleButtonRightstringBubble button right offset (default: 0)
showBubbleButtonbooleanShow floating bubble (default: true)
openbooleanOpen chat on load (default: true)
useStreambooleanStream responses (default: true)
showBotAvatarbooleanShow bot avatar (default: true)
isAsyncMessagebooleanAsync message mode
isStarterMessagesDetailsbooleanShow starter message details
isBubbleButtonDraggablebooleanMake bubble draggable
isBubbleAnimationActivebooleanBubble animation
isChiefAgentAvailablebooleanChief agent availability

Example URL

https://YOUR_WIDGET_APP/widget.html?agentId=abc-123&baseUrl=https://YOUR_API&username=john&language=en&showBubbleButton=true