Aura Home SDK Documentation

The Aura Home SDK is the customer-side integration layer for embedding Aura Home inside partner, broker, portal, or enterprise websites.

Install the package, create a host container, and initialize a runtime deployment.

Prepare portal, identity, environment, certificate, and support information before implementation.

Review supported options, instance methods, lifecycle events, resolved appearance metadata, and configuration contracts.

Configure SDK theme requests, dashboard-published chatbot profiles, result-card tokens, and theme revisions without raw HTML or scripts.

Understand required and recommended OIDC/JWT claims for enterprise SSO.

Follow a practical white-label embed flow from container setup to launch checks.

Implement portal SSO, SAML bridge authentication, SSL certificates, HTTPS embeds, and launch validation.

Plan dev, staging, and production runtime configuration.

Diagnose common customer integration failures.

Understand how the SDK sits in the broader Aura Home agent platform.

Core Capabilities

Embed Aura Home in an iframe controlled by the SDK lifecycle.
Choose visible sections such as chat, profile, navigation, onboarding, pricing, and legal pages.
Request runtime-approved themes such as cadisa through theme.id.
Apply customer brand identity through allowlisted color, typography, loader, result-card, and optional hosted stylesheet settings.
Pass enterprise identity through a token callback without putting tokens in URLs.
Listen to lifecycle events and issue commands such as openChat() and openProfile().
Read resolved appearance metadata through appearanceResolved and getResolvedAppearance().
Inspect result-card enablement, renderer catalog metadata, card tokens, and the active themeRevision for support.