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
agentId— Agent identifier (or uselabel)baseUrl— Your API base URL (e.g.https://maistro/api/v1/)
Props (query parameters)
All options are passed as URL query parameters. Boolean values use true / false.
| Prop | Type | Description |
|---|---|---|
agentId | string | Agent identifier (provide agentId or label) |
label | string | Agent label, alternative to agentId (provide agentId or label) |
baseUrl | string | API base URL |
closeRedirectUrl | string | Redirect URL on close |
teamLabel | string | Team label |
username | string | User display name (default: guest-user) |
tokenRef | string | Session token ref (passed as X-Token-Ref header) |
language | string | Locale (e.g. tr, en) |
type | string | Agent type (default: SequentialConversationalRAGAgent) |
channel | string | Channel identifier |
mode | string | Mode (default: internal) |
primaryColor | string | Primary accent color |
botTitle | string | Bot display title |
botAvatarImg | string | Bot avatar image URL |
bubbleButtonUrl | string | Custom bubble button image URL |
bubbleButtonWidth | string | Bubble button width (default: 150px) |
bubbleButtonHeight | string | Bubble button height (default: 150px) |
bubbleButtonRight | string | Bubble button right offset (default: 0) |
showBubbleButton | boolean | Show floating bubble (default: true) |
open | boolean | Open chat on load (default: true) |
useStream | boolean | Stream responses (default: true) |
showBotAvatar | boolean | Show bot avatar (default: true) |
isAsyncMessage | boolean | Async message mode |
isStarterMessagesDetails | boolean | Show starter message details |
isBubbleButtonDraggable | boolean | Make bubble draggable |
isBubbleAnimationActive | boolean | Bubble animation |
isChiefAgentAvailable | boolean | Chief agent availability |
Example URL
https://YOUR_WIDGET_APP/widget.html?agentId=abc-123&baseUrl=https://YOUR_API&username=john&language=en&showBubbleButton=true