API Reference

Configuration

Customize your agent’s appearance, behavior, and functionality by setting the properties below. These options allow you to control everything from logos and themes to layout and audio features.

PropertyTypeRequired?Description
displayNamestringNoThe agent’s display name
logoUrlstringNoURL for the agent’s primary logo.
modalLogoUrlstringNoURL for the logo used within modals or dialogs.
titleTextstringNoThe main heading displayed in the agent panel.
quickStartHintstringNoInstructional text guiding users on quick-start actions.
quickRepliesArray<{ title: string; subtitle?: string }>NoA list of preset buttons to kick off common conversations.
theme<see Theme Properties below>NoColor, font and bubble styling options
isLogoVisiblebooleanNoToggle to show or hide the agent’s logo.
isLTRbooleanNoText direction: left-to-right (true) or right-to-left (false).
isAudioEnabledbooleanNoAllow users to send voice input instead of typing.
resumePreviousSessionbooleanNoAutomatically reload the last session if the previous interaction was within 24 hours.

Theme Properties

PropertyTypeRequired?Description
primaryColorstringNoBrand or primary color
secondaryColorstringNoSecondary color
primaryFontColorstringNoPrimary text color
secondaryFontColorstringNoSecondary text color
backgroundColorstringNoWidget background color
speechBubblestringNoSpeech-bubble color
speechBubbleTextstringNoText color inside speech-bubbles
widgetBubbleBackgroundColorstringNoBubble handle backgroundColor (this property apply only mode "OVERLAY" & layoutMode "WIDGET")
fontFamilystringNoUI font family

You can also configure all of these settings in our Studio. Note that any SDK-side configuration will override the Studio values—allowing you to vary settings on a per-page or contextual basis.


Example

eucera("when", "ready", () => {
  eucera.agent({
    apiName: AGENT_API_NAME, 
    mode: "EMBEDDED", 
    configuration: {
      // UI text & icons
      displayName:       "Support Bot",
      logoUrl:           "https://example.com/logo.png",
      modalLogoUrl:      "https://example.com/modal-logo.png",
      titleText:         "How can I help you today?",
      quickStartHint:    "Try one of these quick commands:",
      quickReplies: [
        { title: "Show me features",    subtitle: "What this bot can do" },
        { title: "Contact support",     subtitle: "Talk to a human" }
      ],

      // Theme & styling
      theme: {
        primaryColor:                "#0055FF",
        secondaryColor:              "#FF5500",
        primaryFontColor:            "#FFFFFF",
        secondaryFontColor:          "#333333",
        backgroundColor:             "#F4F4F4",
        speechBubble:                "#E0E0E0",
        speechBubbleText:            "#000000",
        widgetBubbleBackgroundColor: "#FF0000",
        fontFamily:                  "Arial, sans-serif"
      },

      // Feature toggles
      isLogoVisible:         true,
      isLTR:                 true,
      isAudioEnabled:        false,
      resumePreviousSession: true,
    }
  });
});

Configuration at Runtime

Update any part of the AgentConfiguration after initialization—logos, theme, quick replies, etc.


eucera("when", "ready", () => {
  const agent = eucera.agent({ /* …common setup… */ });
  agent.setConfiguration({
    displayName: "Support Bot",
    logoUrl: "https://cdn.example.com/logo.png",
    theme: { /* … */ }
  });
});