Augeo AI Docs
SDKs

Overview

Overview

The Chat SDK loyalty widget is an embeddable concierge for program members. It mounts on your host site and talks to the production AI API.

This page defines the public integration model. It also lists host duties and links every task area in the guide.

Prerequisites

ItemRequirement
Host pageServes HTTPS and can load a third-party script
DOM mountA container element exists before you construct the assistant
Member tokenYour backend supplies a bearer token for the signed-in member
PersonaPublic embeds use the loyalty-concierge persona only

Integration model

The supported third-party path is script embed. Load one production IIFE bundle. Read the constructor from the bundle global. Construct AugeoAssistant with a container and token callback.

Pass AugeoAssistantOptions. Required fields are container and auth.getToken. Optional fields are auth.onFailure, apiBaseUrl, onError, branding, surface, capabilities, and host.

The production CDN script is the supported host install path.

Production bundle

ConstantValue
Production CDN hosthttps://sdks.augeoai.net
Persona path segmentloyalty-concierge
IIFE globalwindow.AugeoChatSdkLoyaltyConcierge
Custom elementchat-sdk-loyalty-concierge
Pinned production scripthttps://sdks.augeoai.net/chat-sdk/loyalty-concierge/0.10.0/index.js
Pinned script patternhttps://sdks.augeoai.net/chat-sdk/loyalty-concierge/<version>/index.js
Latest script path (development)https://sdks.augeoai.net/chat-sdk/loyalty-concierge/latest/index.js

Pin a version in production traffic. Upgrade only when you choose a new release.

The production bundle already targets the production API. Omit apiBaseUrl unless you must override it.

Host responsibilities

Your host owns authentication, mount layout, and member-side effects.

DutyHost action
AuthImplement auth.getToken so every request gets a current bearer token
Auth recoveryHandle auth.onFailure when the server rejects an expired token
Mount targetProvide a CSS selector that resolves before construction
LayoutChoose inline, modal, or sidebar through surface.type
BrandingSet branding.agentName and branding.theme for partner colors
Intent handlingAct on recommend-only events such as cart, wishlist, click, and support
LifecycleCall destroy() when the host route or session ends
ErrorsRoute onError into host telemetry or user messaging

auth.getToken must return a string synchronously. A Promise stringifies in the Authorization header.

The widget recommends actions. It does not mutate your cart or wishlist itself.

surface.type is the only field that selects the shell. Omitted surface resolves to inline.

Task areas

TaskPage
Embed and tear down in minutesQuick start
Set root optionsConfiguration
Choose inline, modal, or sidebarSurfaces
Embed personalized reward cardsFor You widget
Recolor partner UIBranding
Toggle featuresCapabilities
Handle member intentsEvents
Forward events to gtagAnalytics
Review public typesAPI
Fix common integration failuresCommon issues

Search widget

The Search SDK is a separate browser bundle with its own mount and authentication callback. It provides recent searches, recommendations, typeahead, catalog results, and an optional handoff to chat.

Start with the Search SDK overview or follow its quick start.