Embed conversational agents

You can embed a Conversational Agent directly inside a UiPath App or any third-party application using an IFrame. This allows users to easily interact with agents without leaving the application.

Embedding Conversational Agents in UiPath Apps Prerequisites

1. Create and publish a conversational agent.
2. Open your app project in Studio and add an IFrame component to your page.
3. Set the IFrame source URL using the following format:

   "https://<cloud_env>.uipath.com/<organization>/<tenant>/autopilotforeveryone_/conversational-agents/?agentId=<agent_id>&mode=embedded&title=<title>&welcomeTitle=<welcome_title>&welcomeDescription=<welcome_description>&suggestions=<suggestions>"

   Important: The Organization and the Tenant may be the agent's ID or the agent's Name

   Paramètres requis

   • agentId: Release ID of the published of the published conversational agent.

   Paramètres facultatifs

   • mode - Can be embedded or fullscreen (default value is fullscreen).
   • title - The title of the chat component. Defaults to the name of the Agent.
   • welcomeTitle - First run experience title displayed in the middle of screen. Defaults to an empty string ''.
   • welcomeDescription - First run experience description. Defaults to an empty string ''.
   • suggestions - First run experience suggestions. Defaults to an empty array []. Example: ["Hi, what can you do", "Hello, how are you"].
     Note: To test on browser directly, wrap in one set of double quotes. For Apps embedding, wrap in two sets of double quotes.
   • showHistory - Show history panel. Defaults to true.
   • jobStartOverrides - Overrides for the conversational-agent jobs that run when serving the conversation. When not passed in or when runAsMe is undefined, CAS will run the job with default job-start settings RunAsMe: false. Example: jobStartOverrides={"runAsMe":true}
     Note: To test on browser directly, wrap in one set of double quotes. For Apps embedding, wrap in two sets of double quotes.

     Example URL for embedding conversational agents in Apps

     "https://<cloud_env>.uipath.com/<organization>/<tenant>/autopilotforeveryone_/conversational-agents/?agentId=<agent_id>&mode=embedded&title=Conversational Agents&welcomeTitle=Welcome to conversational agents&welcomeDescription=Talk with your agent to get started&suggestions=[""Hi, what can you do"", ""Hello, how are you""]"

4. Publish your app. Your agent is now embedded and ready to use.
   
   
   
   

Embed Conversational Agents in 3rd party services

1. Create and publish a conversational agent.
2. Add an <iframe> element to your application where you want the conversational agent to appear.
3. Set the IFrame source attribute using the following format:

   "https://<cloud_env>.uipath.com/<organization>/<tenant>/autopilotforeveryone_/conversational-agents/?agentId=<agent_id>&mode=embedded&title=<title>&welcomeTitle=<welcome_title>&welcomeDescription=<welcome_description>&suggestions=<suggestions>"

FAQ

How do you retrieve the agentId?

• Navigate to Agents > Conversational Agents, open your agent, and copy the agentId from the URL.

Is there a way to make Conversational Agent public?

• Not yet. Public access requires additional work related to authentication, security, and licensing.

Is it possible to inject some context to the client?

• Support for injecting inputs into Conversational Agents is in development.