# About the Widget Settings API

The AI Site-Chat Widget Settings API allows you to manage your AI Site-Chat's settings. Learn more about [configuring your AI Site-Chat's settings](fallback::https://support.wix.com/en/article/adding-and-setting-up-the-wix-ai-chat-assistant#step-2-configure-your-ai-site-chats-settings).

With this API, you can:
- Retrieve current AI Site-Chat settings.
- Update AI Site-Chat settings.

> **Note:** Wix AI Site-Chat is currently only available in the Wix Editor.

## 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](fallback::https://www.wix.com/app-market/web-solution/wix-ai-assistant-client) app. Learn more about [adding and setting up Wix AI Site-Chat](fallback::https://support.wix.com/en/article/adding-and-setting-up-the-wix-ai-chat-assistant).

## Use cases
- [Retrieve and update widget settings](fallback::https://dev.wix.com/docs/rest/business-management/ai-site-chat/ai-site-chat/widget-settings/sample-flows#retrieve-and-update-widget-settings)
- [Display a message if the AI assistant is offline](fallback::https://dev.wix.com/docs/rest/business-management/ai-site-chat/ai-site-chat/widget-settings/sample-flows#display-a-message-if-the-ai-assistant-is-offline)

# Widget Settings: Sample Use Cases and Flows

This article shares some possible use cases your app or site could support, as well as a sample flow that could support each use case. This can be a helpful jumping-off point.

## Retrieve and update widget settings
To retrieve and update the widget settings:

1. Call [Get Widget Settings](fallback::https://dev.wix.com/docs/rest/business-management/ai-site-chat/ai-site-chat/widget-settings/get-widget-settings) to retrieve the current settings.
1. Update the settings retrieved. For example, update the intro message.
1. Call [Set Widget Settings](fallback::https://dev.wix.com/docs/rest/business-management/ai-site-chat/ai-site-chat/widget-settings/set-widget-settings), specifying the updated settings, to save the updated settings.

## Display a message if the AI assistant is offline. 

To display a message if the AI assistant is offline:

1. Call [Get Widget Settings](fallback::https://dev.wix.com/docs/rest/business-management/ai-site-chat/ai-site-chat/widget-settings/get-widget-settings).
1. Check the value of `assistantOnline` in the response.
1. If it's `false`, display a message on the site.

Coding Examples

Sled Tests

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

Picasso

GraphQL (Alpha)

# Widget Settings: Sample Use Cases and Flows

This article shares some possible use cases your app or site could support, as well as a sample flow that could support each use case. This can be a helpful jumping-off point.

## Retrieve and update widget settings
To retrieve and update the widget settings:

1. Call [Get Widget Settings](fallback::https://dev.wix.com/docs/rest/business-management/ai-site-chat/ai-site-chat/widget-settings/get-widget-settings) to retrieve the current settings.
1. Update the settings retrieved. For example, update the intro message.
1. Call [Set Widget Settings](fallback::https://dev.wix.com/docs/rest/business-management/ai-site-chat/ai-site-chat/widget-settings/set-widget-settings), specifying the updated settings, to save the updated settings.

## Display a message if the AI assistant is offline. 

To display a message if the AI assistant is offline:

1. Call [Get Widget Settings](fallback::https://dev.wix.com/docs/rest/business-management/ai-site-chat/ai-site-chat/widget-settings/get-widget-settings).
1. Check the value of `assistantOnline` in the response.
1. If it's `false`, display a message on the site.
    


value

BoolValue

StringValue

nanos

seconds

Timestamp

Whether the AI Assistant is always online. If `true`, `schedule` and `timeZone` are ignored.

always

Times at which the AI Assistant is online.

timeZone

ActiveHours

Whether the AI Site-Chat should send the contact form if the AI is unable to answer the site visitor's question.

cannotAnswer

Whether the AI Site-Chat should send the contact form if the site visitor requests to chat with a real person.

requestForPerson

Conditions

When the AI Site-Chat should send the contact form.

ContactForm

enabled

Array of times during which the AI Assistant is active.

frames

DaySchedule

Whether to include an email field in the form.

email

Whether to include a message field in the form.

message

Whether to include a name field in the form.

name

Whether to include a phone number field in the form.

phone

Fields

GetWidgetSettingsRequest

Whether the assistant is currently online.

assistantOnline

GetWidgetSettingsResponse

Message shown as poput to engage the site visitor with the AI assistant.

IntroMessage

Allows the site visitor to write messages, but doesn't send a contact form.

Doesn't allow the site visitor to write messages, but does send a contact form.

Allows the site visitor to write messages and sends a contact form.

OfflineBehavior

Schedule

SetWidgetSettingsRequest

SetWidgetSettingsResponse

text

SettingsMessage

Times the AI assistant is available on the site.

Whether to open the AI Site-Chat automatically when the site loads.

autoOpen

Avatar image id user can set for the AI assistant.

avatar

Date and time the widget settings were created.

createdDate

Whether the AI Site-Chat is enabled on the site.

AI Site-Chat introduction. This is shown in the chat when a site visitor starts a new conversation.

Whether the AI Site-Chat should send page summary of the site visitor's navigation on the site.

navigationSummary

Defines what the AI Site-Chat provides during the non-active hours.

offlineBehavior

Date and time the widget settings were updated.

updatedDate

WidgetSettings

start

WorkingHoursFrame

Retrieves the widget settings for the site.

Innovation Lab Administrator

Innovation Lab User

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

async function getWidgetSettings() {
  const response = await widgetSettings.getWidgetSettings();
};

getWidgetSettings

import { createClient } from '@wix/sdk';
import { widgetSettings } from '@wix/ai-site-chat';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { widgetSettings },
  // Include the auth strategy and host as relevant
});


async function getWidgetSettings() {
  const response = await myWixClient.widgetSettings.getWidgetSettings();
};

Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).

getWidgetSettings (self-hosted)

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

async function setWidgetSettings(widgetSettings) {
  const response = await widgetSettings.setWidgetSettings(widgetSettings);
};

setWidgetSettings

import { widgetSettings } from '@wix/ai-site-chat';
import { auth } from '@wix/essentials';

async function mySetWidgetSettingsMethod(widgetSettings) {
  const elevatedSetWidgetSettings = auth.elevate(widgetSettings.setWidgetSettings);
  const response = await elevatedSetWidgetSettings(widgetSettings);
}

setWidgetSettings (with elevated permissions)

import { createClient } from '@wix/sdk';
import { widgetSettings } from '@wix/ai-site-chat';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { widgetSettings },
  // Include the auth strategy and host as relevant
});


async function setWidgetSettings(widgetSettings) {
  const response = await myWixClient.widgetSettings.setWidgetSettings(widgetSettings);
};