Website SDK

Introduction

The Website SDK (iframe) allows you to embed your AI agent on any website using a simple iframe code.

This method is designed for teams that want a straightforward, reliable way to place the AI agent inside a specific section of a webpage—without using JavaScript SDKs, frontend frameworks, or backend configuration.

By adding the iframe code to your website, the AI agent becomes instantly available to users.

What the Website SDK (iframe) Does

Using the Website SDK (iframe), you can:

Embed an AI agent on any website using iframe code
Control exactly where the agent appears on the page
Deploy the agent without JavaScript or backend setup
Support chat and voice interactions (if voice is enabled)
Route all conversations into Exei’s unified Conversations inbox

The SDK uses the same AI agent, training data, persona settings, and actions configured in Exei.

How the Website SDK (iframe) Works

The Website SDK uses an iframe to load the AI agent.

The flow works as follows:

Exei generates an iframe embed code for your AI agent
You paste the iframe code into your website’s HTML
The AI agent loads inside the iframe
Users can start interacting immediately

No additional configuration is required.

Where to Find the iframe Embed Code

To access the Website SDK iframe code:

Open your Settings
Go to Channels
Select Website
Copy the iframe embed code

This iframe code is unique to your AI agent and organization.

Customizing Your Website Agent (Widget Appearance & Behavior)

Before deploying the Website SDK or iframe embed to your live site, you can fully customize how the AI agent looks, feels, and interacts with visitors under Settings $\rightarrow$ Website Channels $\rightarrow$ Customize.

Visual Identity Settings

Agent Avatar: Upload a custom brand logo or persona image (JPG, PNG, SVG up to 2MB, square format recommended) to give your AI agent a recognizable face.
AI Agent Name: Set the display name for your AI assistant (e.g., Outfitr, Support Bot) visible in the chat header.
Greeting Message: Customize the initial welcoming text sent to users when they open the chat (e.g., "Hi there! I'm here to help you find the perfect outfit. What are you shopping for today?").

Interaction Design & Trigger Controls

Label Text & Quick Cues: Define custom call-to-action text on the widget button (e.g., "Find Your Style ⭐") and set up Custom Cues / Quick Replies (like "hi", "Lets Shop") for instant one-tap user responses.
Widget UI Controls: Enable toggles for Rounded Corners, Online Status indicator, Emoji Picker, and Agent Icon visibility.
Mount Effects & Positioning: Choose widget animation entrance effects (Bounce vs. Static), set screen alignment (Left vs. Right), and fine-tune exact pixel offsets using Vertical Position and Horizontal Position sliders.

Typography, Theme & Color Palette

Font Styling: Select from system fonts (such as Poppins) and adjust Font Size (Small, Medium, Large) to match your website typography.
Advanced Color Branding: Customize color hex codes across all UI elements—including Background Color, Exei Message Color / Text Color, User Message Color / Text Color, Header Color, Label Text Color, and Icon Colors—ensuring seamless alignment with your corporate design system.

Adding the iframe to Your Website

To embed the agent using the Website SDK:

Open your website’s HTML or CMS editor
Paste the iframe code where you want the agent to appear
Save and publish your website

Once published, the AI agent becomes live immediately.

Voice Support in Website SDK

If voice is enabled for your AI agent:

Voice interactions work inside the iframe
Language and accent are configured under Channels → Voice
Voice conversations are logged with full transcripts

Voice behavior is consistent with other channels such as website chat and VoIP.

Conversations & Tracking

All conversations created through the Website SDK (iframe):

Appear in the Conversations section
Include full message history and transcripts
Support feedback and Instant Retrain
Can be handled using Human Takeover
Are included in Insights (based on plan availability)

There is no difference in tracking or visibility compared to other channels.

When to Use Website SDK (iframe)

Use the Website SDK (iframe) when:

You want fixed placement within a page layout
You are working with static sites or CMS platforms
JavaScript execution is limited or restricted
You want the simplest possible website integration

Best Practices for Website SDK (iframe)

Test the agent in the Playground before embedding
Place the iframe in a visible and accessible section of the page
Customize the agent greeting before going live
Monitor early conversations after deployment
Use Instant Retrain to quickly fix gaps in responses

Page updated

Report abuse