About the Widget Settings API

The Widget Settings API allows you to manage your AI Site-Chat's settings. Learn more about configuring your AI Site-Chat's settings.

With this API, you can:

• Retrieve current AI Site-Chat settings.
• Update AI Site-Chat settings.

Before you begin

It's important to note the following point before starting to code:

• Sites using this API must install the Wix AI Site-Chat app. Learn more about adding and setting up Wix AI Site-Chat.

Use cases

• Retrieve and update widget settings
• Display a message if the AI assistant is offline

Setup

To use the WidgetSettings API, install the @wix/ai-site-chat package using npm or Yarn:

npm install @wix/ai-site-chat

or

yarn add @wix/ai-site-chat

Then import { widgetSettings } from @wix/ai-site-chat:

import { widgetSettings } from "@wix/ai-site-chat";