<AdsProvider> props
string
required
Your unique publisher token.
string
required
Unique identifier that remains the same for the user’s lifetime (used for retargeting and rewarded ads).
string
Email of the user.
string
required
Unique ID of the conversation.
array
Placement codes enabled for the conversation. Defaults to
['inlineAd'].object
Character object used in this conversation.
object
Regulatory object used in this conversation.
string
Publisher-provided identifier for the user cohort (for A/B testing).
function
Callback triggered when an event occurs. See Supported events below.
function
Callback for SDK-internal diagnostic events. Receives
(name, data?) — useful when investigating preload/session behaviour during integration. Off by default.useAds() hook
Returns addMessage, a forwarder that always routes to the current session. If <AdsProvider> swaps the session (e.g. publisherToken change), the next call hits the new one automatically.
function
required
(message: Message, options?: AddMessageOptions) => void — register a new chat message with the SDK. The next preload is scheduled automatically.AddMessageOptions currently exposes one flag:Message shape
string
required
Unique ID of the message.
string
required
Role of the message (
user or assistant).string
required
Message text.
Date
required
Timestamp when the message was created.
<InlineAd> props
string
required
Unique ID of the message this ad belongs to.
string
Placement code provided during onboarding. Defaults to
'inlineAd'.string
Theme of the ad, e.g.
light or dark.function
Render-prop function that lets you wrap the ad iframe in your own markup. The function receives the rendered ad as a React node:
<ErrorBoundary>
<InlineAd> is wrapped in an internal ErrorBoundary so a broken ad never crashes the host app. The component is also exported in case you want to wrap your own logic: