> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flowx.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Chat

> Enable interactive AI agent conversations with end-users through a conversational interface in FlowX applications.

The Chat component provides a conversational interface for AI-powered interactions. It enables real-time messaging between users and AI agents within your FlowX applications.

<video controls autoPlay muted loop src="https://s3.eu-west-1.amazonaws.com/docx.flowx.ai/5.x/chat_comp.mp4" />

## Overview

> [card] Real-time messaging
>
> Send and receive messages instantly with streaming support

> [card] AI agent integration
>
> Connect to workflows powered by AI agents

> [card] Session management
>
> Automatic session handling and persistence across page refreshes

> [card] Customizable UI
>
> Themeable components with independent styling for agent and user messages

## Adding to a UI Flow

**1. Navigate to UI Flows**

Open your project and go to **UI Flows** from the left navigation menu.

**2. Select or create a UI Flow**

Select an existing UI flow or create a new one.

![UI Flows](https://s3.eu-west-1.amazonaws.com/docx.flowx.ai/chat-overview.png)

**3. Open UI Assets panel**

In the left sidebar, expand the **UI Assets** panel. Find Chat alongside Table, Collection, and other components.

![UI Assets](https://s3.eu-west-1.amazonaws.com/docx.flowx.ai/5.x/chat2.png)

**4. Add and configure**

Drag **Chat** onto the canvas, then configure properties in the right panel.

***

## Configuration

### Key settings

| Property | Description |
| - | - |
| **AI Conversational Workflow** | The agent workflow that handles chat interactions. It is set once per UI flow and shared by every Chat component in it. If none is set, select **Select workflow** to open the UI flow **Settings** → **Chat Options** tab |
| **Welcome message** | Initial greeting shown when chat opens. Default: "You're chatting with an AI assistant. Its responses may be inaccurate, so verify important information." If you change it, keep both the AI disclosure and the accuracy reminder |
| **Thinking message** | Text displayed while agent processes (default: "Thinking...") |

### Component hierarchy

The Chat component has configurable sub-components:

```
📁 Chat
  ├── 📄 Header (title, subtitle, available actions)
  ├── 📁 Messages
  │     ├── 💬 Agent Message (avatar, text styling)
  │     ├── 💬 User Message (bubble styling)
  │     ├── 📎 Attached Files (files sent with a user message)
  │     │     └── 📄 File Item (one row per sent file)
  │     ├── 🎙️ User Voice Message
  │     ├── ⚠️ Error Message
  │     ├── 💡 Suggested Prompts (pre-configured prompt suggestions)
  │     └── 👍 Message Actions (copy and rate an agent reply)
  ├── ⌨️ Input (send button)
  │     ├── 📝 Text Input (placeholder)
  │     ├── 🎙️ Voice Input
  │     └── 📎 File Attachments (accepted types, limits, error messages)
  │           └── 📄 File Item (one row per pending file)
  └── 🕘 History
```

![Chat Component Anatomy](https://s3.eu-west-1.amazonaws.com/docx.flowx.ai/chat-anatomy.png)

### Settings by sub-component

> [accordion] Chat (root)
>
> | Property | Description |
> | - | - |
> | **AI Conversational Workflow** | Shows the workflow set for this UI flow in **Settings** → **Chat Options** |
> | **Reset session on load** | Inline only. Creates a new chat session each time the page is loaded through a navigation action. Off by default |
> | **Show header** | Inline only. Shows or hides the **Header** sub-component. On by default |
> | **Welcome message** | Initial greeting (supports variables: `${customerName}`) |
> | **Thinking message** | Text shown during processing |
>
> The **Advanced** section holds an **Analytics name** field. Turning it on shows **Analytics custom payload**. An Overlay chat uses it to track when the chat is opened; an Inline chat has no analytics field. **Text Input**, **Suggested Prompts**, **Voice Input**, and **Message Actions** have their own **Analytics name** field.
>
> ![Chat Component](https://s3.eu-west-1.amazonaws.com/docx.flowx.ai/chat-props.png)

> [accordion] Header
>
> | Property | Description |
> | - | - |
> | **Title** | Main header text |
> | **Subtitle** | Secondary text below title |
> | **Show chat icon** | Toggle avatar icon visibility |
> | **Show separator** | Toggle separator line |
>
> Under **Available actions**, the **New conversation** and **History** toggles control whether the header shows the button for starting a new conversation and the button for opening past conversations.
>
> A new Chat starts with the title "My chat", the subtitle "You're chatting with an AI assistant", and the chat icon, separator, and both available actions turned on.
>
> ![Header](https://s3.eu-west-1.amazonaws.com/docx.flowx.ai/chat-header.png)

> [accordion] Chat History
>
> | Property | Description |
> | - | - |
> | **Title** | Heading displayed on the chat history panel |
>
> **Searching past conversations**
>
> End users can search the conversation list from the history panel. Searching starts once the query is at least 3 characters long, ignoring leading and trailing spaces, and results replace the list while the query is active.
>
> > [!NOTE]
> >
> > Conversation previews in the list can show raw Markdown characters such as `#` and `*` when an agent reply contains them. Rendering Markdown in the preview line is not yet supported.

> [accordion] Agent Message
>
> | Property | Description |
> | - | - |
> | **Show avatar** | Toggle agent avatar visibility |
>
> ![Agent Message](https://s3.eu-west-1.amazonaws.com/docx.flowx.ai/5.x/agent_message.png)

> [accordion] Error message
>
> Shown in place of an agent reply when the reply could not be generated.
>
> | Property | Description | Default |
> | - | - | - |
> | **Error message** | Text shown when the agent reply fails | "There was an error generating this message." |
> | **Show avatar** | Toggle the agent avatar next to the error | `On` |

> [accordion] Message actions
>
> Lets end users copy and rate an agent reply.
>
> | Property | Description | Default |
> | - | - | - |
> | **Show timestamp** | Shows the time the reply was sent | `On` |
> | **Show copy action** | Shows a button that copies the reply | `On` |
> | **Show response feedback actions** | Shows thumbs up and thumbs down buttons for rating the reply | `On` |
> | **Feedback reasons** | Predefined reasons a user can pick when rating a reply. Appears only when **Show response feedback actions** is on. Up to 6 reasons, each required and at most 30 characters | None |

> [accordion] Input
>
> | Property | Description | Default |
> | - | - | - |
> | **Enable voice input** | Show the microphone button so users can send voice messages. | `Off` |
> | **Enable file attachments** | Show the attach button so users can send files together with a message. | `Off` |
>
> The hint text sits on the **Text Input** child: set **Placeholder** there, for example "Ask me anything...". **Text Input** also has an **Analytics name** field, which tracks each message sent from the input. The message text is never sent.
>
> ![Input](https://s3.eu-west-1.amazonaws.com/docx.flowx.ai/chat-input.png)
>
> ![Text Input settings with the Placeholder field](https://s3.eu-west-1.amazonaws.com/docx.flowx.ai/chat-input-text.png)
>
> For runtime behavior (recording limits, playback rules) see [Voice input](https://docs.flowx.ai/6.x/ai-platform/chat-component.md#voice-input) in the Chat component reference. Turning on **Enable file attachments** activates the **File Attachments** sub-component below.
>
> **Turning off the input on a business condition**
>
> Select the chat **Input**, then open **Settings** → **Expressions**, add an expression of type **Disable**, and write a JavaScript condition. When it evaluates true, users can still read the conversation but cannot send a new message. The chat **Input** supports only the **Disable** expression type. See [Hide and disabled conditions](https://docs.flowx.ai/6.x/docs/building-blocks/ui-designer/ui-designer.md#hide-and-disabled-conditions) for how conditions behave across components.
>
> Use it to close a conversation once a journey reaches a terminal state, for example after a case is submitted or a decision is returned, while keeping the transcript readable.
>
> > [!WARNING]
> >
> > Available on Web and Android. The iOS renderer does not evaluate the **Disable condition** yet, so on iOS the input stays enabled.

> [accordion] Suggested Prompts
>
> Displays pre-configured prompt suggestions before the user types. Child of **Messages** (alongside Agent Message and User Message).
>
> | Property | Type | Default | Description |
> | - | - | - | - |
> | **Section title** | string | `"Suggested Prompts"` | Heading text displayed above the suggestions |
> | **Prompts** | string\[] | — | Up to 5 prompts, each required and at most 70 characters, shown as clickable suggestions |
>
> Clicking a suggestion sends it as the user's message. Long prompts are truncated and revealed via tooltip.

> [accordion] File Attachments
>
> Lets end users send files together with a text message. Turn on **Enable file attachments** on the **Input** sub-component to activate it, then configure the accepted files and the error copy here.
>
> Hierarchy is **Chat** → **Input** → **File Attachments** → **File Item**. Files the user has already sent appear under **Messages** → **Attached Files** → **File Item**.
>
> | Property | Description | Default |
> | - | - | - |
> | **Accepted file types** | File types the picker accepts, for example `png, jpg, pdf` | All types |
> | **Invalid file message** | Shown on a file whose type is not accepted | — |
> | **Max number of files** | Maximum files per message. The Designer rejects any value above 10 | `10` |
> | **Max files error message** | Shown when the file count is exceeded | — |
> | **Max files size (in bytes)** | Maximum total upload size, for example `5000000` | `5000000` |
> | **Files size error message** | Shown when the size limit is exceeded | — |
>
> > [!WARNING]
> >
> > All six fields are required once file attachments are turned on. The defaults above are the runtime fallbacks the renderer applies when a field is left empty, not values the Designer fills in for you.
>
> **File Item** has no properties of its own. It is the per-file row, and it carries its own default and error styling.
>
> For upload behavior, error handling, and how uploaded files reach the agent, see [File attachments](https://docs.flowx.ai/6.x/ai-platform/chat-component.md#file-attachments) in the Chat component reference.

***

## Styling

Configure visual styling through **Theme Admin** (Design Assets → Themes → Components → Chat).

### Themeable elements

| Element | Key properties |
| - | - |
| **Chat container** | Padding, border, background, shadow |
| **Header** | Title/subtitle text styles, separator |
| **Messages area** | Padding, gap between messages |
| **Agent Message** | Avatar icon, text style, background |
| **User Message** | Bubble border, radius, background, text |
| **Error message** | Padding, border, radius, background, text style, gap, error icon |
| **Message actions** | Padding, gap, timestamp text style and color, copy and thumbs up/down icons with hover and pressed states |
| **Message feedback** | Padding, gap |
| **Message feedback reason** | Padding, font, border, radius, and colors for the unselected, selected, and hover states |
| **History search** | Padding, border, radius, font, colors for the empty, active, filled, hover, and disabled states, search and clear icons |
| **Notification dot** | Background, border, font, text color |
| **Suggested Prompts** | Title text style, prompt chip appearance, hover state |
| **Input area** | Border, background, send icon, attach icon |
| **File Attachments / File Item** | Padding, border, radius, background, file name and file info text, delete and download icons, plus an error state on File Item |

> [!TIP]
>
> All styling can be configured in Theme Admin for consistent branding. Changes preview in real-time.

***

## Display modes

> [!NOTE]
>
> The Chat component has two display modes, **Inline** and **Overlay**. An Overlay chat renders as **Floating**, **Full Screen**, or both.

When adding a Chat component, the **Chat Display Type** dialog asks how the chat renders and where it can be placed.

| Display mode | Description | Placement |
| - | - | - |
| **Inline** | Renders within the parent component, filling the available space | Parent is a **Container** or **Card** |
| **Overlay** | Renders on top of the root content, as a full-screen view or a floating widget | Parent is not a **Container** or **Card** |

When you pick **Overlay**, select **Floating**, **Full Screen**, or both. **Floating** is selected by default, and at least one of the two must stay selected. A Floating chat opens from a FAB (Floating Action Button).

> [!NOTE]
>
> To change the display mode after creation, right-click the Chat and select **Edit Display Types**. The option appears only when the Web platform is selected.

On the Mobile device type, dropping a Chat does not open the dialog: inside a **Card**, **Container**, or **Tab** it is placed Inline, and anywhere else it is placed Full Screen.

> [!WARNING]
>
> **Placement constraints:** Inline is only available when the parent is a **Container** or **Card**. Overlay is only available when the parent is not a **Container** or **Card**. Unavailable options are disabled in the selection dialog.

### Sizing defaults

| Display mode | Default width | Default height | Notes |
| - | - | - | - |
| **Inline** | Fill (parent) | Fill (parent) | Supports Fill or Fixed sizing |
| **Full Screen** | Full viewport | Full viewport | No sizing controls |
| **Floating** | `420px` (fixed) | `640px` (fixed) | FAB at `right: 24px`, `bottom: 24px` |

> [!TIP]
>
> For Inline, you can switch between **Fill** and **Fixed** sizing for both width and height. For Floating, width and height are fixed values you can customize in the style panel.

The sizing controls appear in the style panel only when the Web platform is selected.

### Floating action button (FAB)

Floating and FullScreen modes include a **Floating Action Button** that triggers the chat. The FAB is configurable in the style panel:

| Property | Default | Description |
| - | - | - |
| **Width** | `56px` | FAB button width |
| **Height** | `56px` | FAB button height |
| **Position** | Right: `24px`, Bottom: `24px` | Fixed position on screen |

#### Notification dot

When an agent replies while the chat is collapsed, a notification dot appears on the floating action button so users see there is something to read. The dot shows the number of unread agent replies, displayed as "9+" above nine. It clears when the user opens the chat.

Style it in the **Notification dot** section of the chat style panel. The values apply to both Floating and FullScreen modes.

| Property | Default | Description |
| - | - | - |
| **Height** | `22px` | Dot diameter |
| **Offset X** | `0` | Horizontal offset from its anchor on the button |
| **Offset Y** | `0` | Vertical offset from its anchor on the button |

> [!NOTE]
>
> The dot does not survive a page refresh. If a user reloads the page before opening the chat, the dot clears even though the agent reply is still unread.

### Theming per display mode

Theme values are configured independently per display mode and per platform (Web, Android, iOS) through **Design Assets → Themes → Components → Chat**. Supported properties include padding and margin for each mode.

For complete runtime details, see the [Chat component reference](https://docs.flowx.ai/6.x/ai-platform/chat-component.md#display-modes).

***

## Advanced documentation

For comprehensive documentation including runtime behavior, session management, custom persistence workflows, SDK integration, and troubleshooting:

> [card] [Chat component - Full reference](https://docs.flowx.ai/6.x/ai-platform/chat-component.md)
>
> Complete technical documentation in AI Platform section

## Related resources

> [card] [Chat interface concepts](https://docs.flowx.ai/6.x/ai-platform/using-agents/chat-interface.md)
>
> High-level chat integration patterns

> [card] [AI Triggers](https://docs.flowx.ai/6.x/ai-platform/chat-driven-workflows.md#ai-triggers)
>
> Launch chat-driven workflows with structured trigger messages

> [card] [Knowledge bases](https://docs.flowx.ai/6.x/docs/platform-deep-dive/integrations/knowledge-base-integration/knowledge-base-overview.md)
>
> Ground AI responses in your data

> [card] [AI in FlowX](https://docs.flowx.ai/6.x/ai-platform/ai-in-flowx.md)
>
> AI capabilities overview


## Related topics

- [Chat component](https://docs.flowx.ai/6.x/ai-platform/chat-component.md)
- [Chat interface](https://docs.flowx.ai/6.x/ai-platform/using-agents/chat-interface.md)
- [Chat-driven workflows](https://docs.flowx.ai/6.x/ai-platform/chat-driven-workflows.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.