Agents - iFrame and Apps embedding

agents

latest

false

Agents user guide

iFrame and Apps embedding

Embed a chat agent into web applications or UiPath Apps using iFrame for a seamless, in-app chat experience.

Overview

Embed your chat-based conversational agent into web applications using iFrame. Use this approach to add conversational agents to third-party applications or to UiPath Apps using the iFrame component.

Intended users: Developers and administrators who want to embed conversational agents into custom web applications or UiPath Apps.

Feature availability

Feature	Available
Start new chat	✅
Chat history	✅
Delete chat session	✅
User-profile settings	✅
Starting prompts	✅
File uploads	✅
Conversation inputs*	✅
Tool-call confirmations	✅
Citations	✅
HTML preview	✅
Copy response	✅
Feedback (thumbs)	✅

* Conversation inputs are supported only for Conversational Agents built in Agent Builder.

Prerequisites

To embed a conversational agent, complete the following setup steps:

Admin or developer setup

Publish the conversational agent to your desired Orchestrator folder.
Retrieve the agent release ID from Instance Management.
For UiPath Apps, create an Apps project in UiPath Studio.
For third-party apps, ensure the web application supports iFrame embedding.

Finding the Agent ID

In Instance Management, navigate to Agents > Deployed agents.
Select Chat for the desired agent.
Copy the agent ID from the URL. For example, in the URL https://cloud.uipath.com/conversationalagents/agents_/deployed/chat/342061, the agent ID is 342061.

User requirements

Authenticated users must have a UiPath account with permission to access the agent.
Anonymous users must have access to the application or surface where the agent is embedded.

Embedding the agent

URL construction

Set the iFrame source to a URL with the following format:

https://cloud.uipath.com/<organization>/<tenant>/autopilotforeveryone_/conversational-agents/?agentId=<agent_id>&mode=<mode>
https://cloud.uipath.com/<organization>/<tenant>/autopilotforeveryone_/conversational-agents/?agentId=<agent_id>&mode=<mode>

Note:

The organization and tenant name are case-sensitive.

URL parameters

Parameter	Required	Description
`agentId`	Yes	The Release ID of the published agent
`mode`	No	`embedded` for right-rail experience, `fullscreen` for full-screen (default: `fullscreen`)
`title`	No	Title displayed in chat header (default: agent name)
`welcomeTitle`	No	Title for first-run welcome screen
`welcomeDescription`	No	Description for first-run welcome screen
`suggestions`	No	Array of suggested prompts for first-run
`showHistory`	No	Show/hide chat history panel (default: `true`)

Example URLs

Basic embedded mode

https://cloud.uipath.com/myorg/mytenant/autopilotforeveryone_/conversational-agents/?agentId=12345&mode=embedded
https://cloud.uipath.com/myorg/mytenant/autopilotforeveryone_/conversational-agents/?agentId=12345&mode=embedded

With welcome message and suggestions

https://cloud.uipath.com/myorg/mytenant/autopilotforeveryone_/conversational-agents/?agentId=12345&mode=embedded&title=HR Assistant&welcomeTitle=Welcome!&welcomeDescription=I can help you with HR questions&suggestions=["What is the PTO policy?","How do I submit expenses?"]
https://cloud.uipath.com/myorg/mytenant/autopilotforeveryone_/conversational-agents/?agentId=12345&mode=embedded&title=HR Assistant&welcomeTitle=Welcome!&welcomeDescription=I can help you with HR questions&suggestions=["What is the PTO policy?","How do I submit expenses?"]

Embedding in UiPath Apps

To embed a conversational agent in UiPath Apps, use the iFrame component.

Open your App in UiPath Apps Studio.
Add an iFrame component to your page.
Set the iFrame Source property to the constructed URL.
Publish the app.

When embedding a conversational agent in UiPath Apps, escape the suggestions array by using double quotation marks, as shown in the following example:

suggestions=[""What is the PTO policy?"",""How do I submit expenses?""]
suggestions=[""What is the PTO policy?"",""How do I submit expenses?""]

This is required because UiPath Apps validates the value as a string.

Embedding in third-party applications

You can embed a conversational agent in any web application that supports iFrame embedding.

HTML example

<iframe
  src="https://cloud.uipath.com/myorg/mytenant/autopilotforeveryone_/conversational-agents/?agentId=12345&mode=embedded"
  width="400"
  height="600"
  frameborder="0"
  allow="clipboard-write"
></iframe>
<iframe
  src="https://cloud.uipath.com/myorg/mytenant/autopilotforeveryone_/conversational-agents/?agentId=12345&mode=embedded"
  width="400"
  height="600"
  frameborder="0"
  allow="clipboard-write"
></iframe>

Considerations

Cross-origin policies: Ensure your application's Content Security Policy allows embedding from uipath.com.
Responsive design: Configure appropriate width and height values to ensure proper rendering across screen sizes.
Clipboard access: Include allow="clipboard-write" to enable the copy response feature.

Chat features

The embedded chat experience uses the Instance Management Chat UI, providing the same chat functionality.

Authentication options

Authenticated users

For internal users with UiPath accounts:

Users authenticate using standard UiPath authentication.
The agent has access to the user’s identity information, such as name and email address.
Consumption is tracked against the user’s license.

Anonymous users

For external or unauthenticated scenarios:

A confidential external application must be configured in the Admin portal.
A token endpoint hosted by your organization is required.
No individual user license is required.
Consumption is deducted from the tenant’s unit pool.

For setup instructions, refer to Anonymous access setup.

For licensing details, refer to Licensing.

Warning:

Anonymous access allows users without UiPath accounts to interact with your agent. We highly recommend gating anonymous agents behind your own portal or login to mitigate abuse.

Troubleshooting

iFrame not loading

Verify the URL is correctly constructed.
Check that the agent ID is valid.
Ensure the agent is published and running.
Check browser console for Content Security Policy errors.

Copy not working

Ensure the iFrame includes allow="clipboard-write" attribute.
Check browser permissions for clipboard access.

Next steps

Anonymous access setup: Enable access for users without UiPath accounts
Instance Management: Full feature reference and debugging

Was this page helpful?

PREVIOUSSlack

NEXTAnonymous access setup

Overview​

Feature availability​

Prerequisites​

Admin or developer setup​

Finding the Agent ID​

User requirements​

Embedding the agent​

URL construction​

URL parameters​

Example URLs​

Basic embedded mode​

With welcome message and suggestions​

Embedding in UiPath Apps​

Embedding in third-party applications​

HTML example​

Considerations​

Chat features​

Authentication options​

Authenticated users​

Anonymous users​

Troubleshooting​

iFrame not loading​

Copy not working​

Next steps​