Overview
Easily share your AI agent with others by choosing how they can interact with it. Whether you want to send a live chat link, embed a support widget, showcase tasks in an iframe, or allow full template cloning, you have flexible options to fit any use case.Chat UI
Let others interact with your Agent through a clean, conversation-style interface — just like a chatbot. You can share it via a link or embed it as an iframe. This is perfect for letting people experience your Agent without modifying anything. All usage is billed to your account, and others can use the Agent without needing to set it up themselves.Developer Notes
The
iframe
inherits 100%
of its parent container by default. Configure your container’s dimensions carefully to ensure the iframe displays correctly within your page layout without causing layout issues.Chat Widget
Turn your Agent into a pop-up chat interface you can embed on any website with a simple script tag. It behaves like a support chat window and is ideal for customer-facing use cases like answering questions, handling requests, or collecting feedback directly on your site.Developer Notes
Target the
.relevanceai-chat-bubble-app
class to style the chat bubble. Adjust its z-index
property to position the bubble above or below other UI elements such as cookie popups and toast messages.URL parameter | Type | Values | Description | Examples |
---|---|---|---|---|
primary_color | string | A valid CSS color for your form. | #685fff | |
bubble_style | enum | agent, icon | Use an agents avatar or the bubble_icon . | agent |
bubble_icon | enum | pd/ai-agent, notebook/deploy, pencil, star, sparkle, sparkles, pd/lightning-filled, pd/chat, pd/send-diagonal, stack, duration, pd/check, pd/play, arrow-r, pd/search, share, plus, pd/question-filled | The icon to use if bubble_style is set to icon . | |
input_placeholder_text | string | Set the message input placeholder text. | Type your question here… | |
hide_file_uploads | boolean | Toggle file uploads. | true | |
hide_conversation_list | boolean | Toggle tool steps. | true | |
hide_tool_steps | boolean | Toggle multiple conversations. | true | |
starting_message_prompts | string | Add starting prompts. | ["I need help with my billing", "Write me an email"] | |
hide_logo | boolean | Toggle Relevance AI branding. | false | |
hide_description | boolean | Toggle agent description. | true |