> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/guides-and-quickstarts/interfaces-and-end-user-experiences/publish-a-chat-assistant.md). # Publish a Chat Assistant A chat interface lets people send messages to a workflow and read its responses. Configure which workflow inputs and outputs the interface exposes before publishing it. {% embed url="" %} ## Before you start Have a workflow with the input and output you want to expose in the chat. ## Choose the chat interface Open Interface, choose Chat Assistant, and select Use Interface. ![Chat Assistant interface selection](https://content.gitbook.com/content/SQ1Sgy933krTyK0S4JpP/blobs/V0JIRiFOtPPfVUr4PZml/assets/g055-g055-01-interface.png) This applies the chat layout to the workflow's user-facing experience. ## Map the workflow fields In Fields, select the input and output that the chat should use. ![Chat input and output mappings](https://content.gitbook.com/content/SQ1Sgy933krTyK0S4JpP/blobs/CAbhn63sC5UD7eFJbqDv/assets/g055-g055-02-fields.png) Give them clear aliases while retaining their mappings to the intended workflow nodes. ## Set the welcome content In General, set a Name and short Description, then review the Input Placeholder and avatar. ![Interface welcome content fields](https://content.gitbook.com/content/SQ1Sgy933krTyK0S4JpP/blobs/v5b9QC4h3GIL31Vkco0C/assets/g055-g055-03-identity.png) These settings help users understand who the assistant is for and what to ask. ## Choose conversation options Review Configuration and enable User feedback if users should be able to rate responses. ![Chat conversation configuration options](https://content.gitbook.com/content/SQ1Sgy933krTyK0S4JpP/blobs/KogxkFuWPoQQikveMKR3/assets/g055-g055-04-feedback.png) Enable **Show agent activity** or **Show agent steps** when users need to see progress. For file uploads, enable **Show attachment icon** and select the intended **Files** input in **Fields**. The icon can be visible while that input remains unchecked. **Required** is a separate choice. To let the agent inspect, analyze, or create files, configure its file references, **File Access**, and **Terminal** using [Let an agent work with uploaded files](/guides-and-quickstarts/interfaces-and-end-user-experiences/let-an-agent-work-with-uploaded-files.md). Review audio controls when your workflow uses audio. ## Preview the assistant Use Draft Preview to submit a representative request. ![Chat Assistant draft preview](https://content.gitbook.com/content/SQ1Sgy933krTyK0S4JpP/blobs/Z6TL2fmnwQB5pc8tuJ7t/assets/g055-g055-05-draft.png) Resolve workflow or mapping errors before making the interface available to users. ## Publish and open the assistant Confirm your interface changes are saved. Before publishing, open **Security** and [choose who can access it](/guides-and-quickstarts/interfaces-and-end-user-experiences/interface-authentication-and-access.md). Select **Publish**. The next action depends on your organization’s release controls: * If direct publication is available, review the changes, add a version description, and select **Publish Version**. * If approval is required, [create a project pull request](/guides-and-quickstarts/releases-and-environments/create-a-project-pull-request.md). Wait for an authorized reviewer to [approve the request](/guides-and-quickstarts/releases-and-environments/review-a-project-pull-request.md) before checking the released interface. ![Chat Assistant publication and access](https://content.gitbook.com/content/SQ1Sgy933krTyK0S4JpP/blobs/kvFjTpiNv9qdd8MF7bd0/assets/g055-g055-06-publish.png) A request awaiting approval is not yet a completed deployment. Open Published Interface and submit a request. ![Chat Assistant publication and access](https://content.gitbook.com/content/SQ1Sgy933krTyK0S4JpP/blobs/dKuKTqKGPWXwUXyusT69/assets/g055-g055-07-published.png) Check the displayed identity and actual response in the end-user view. ## Important behavior The interface uses the inputs and outputs mapped in Fields. Changing an alias changes its displayed name, not the underlying workflow node. Saved changes appear in the published interface after the required publication process completes. ## If the published assistant is unavailable * If **Published Interface** is disabled, confirm that publication completed and that no request is still awaiting approval. * If a visitor sees an access prompt, check the saved and published **Security** settings. Project editing permissions and interface access are separate. * If the interface opens but the answer is missing, [inspect the recorded run](/technical-reference/evaluations-and-observability/run-records-node-traces-and-error-details.md) and check the input/output mappings in **Fields**. To place a chat on a website, use [Embedded Chat: Configuration and User Identity](/technical-reference/interfaces-and-conversations/embedded-chat-configuration-and-user-identity.md). ## Continue * [Use a published chat](/guides-and-quickstarts/interfaces-and-end-user-experiences/use-a-published-chat.md) * [Interface branding and feedback](/guides-and-quickstarts/interfaces-and-end-user-experiences/interface-branding-and-feedback.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.stackai.com/guides-and-quickstarts/interfaces-and-end-user-experiences/publish-a-chat-assistant.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.