About the AI Site-Chat APIs

The Wix AI Site-Chat APIs enable you to manage and interact with a site's Wix AI Site-Chat. The Wix AI Site-Chat is a chatbot that site visitors can interact with to get help, ask questions, and connect with Wix users. Learn more about the Wix AI Site-Chat.

The AI Site-Chat APIs consist of 3 integrated services that work together to provide a complete chat experience:

  • Widget settings API: Configures and customizes the appearance, behavior, and availability of the Wix AI Site-Chat on a site. Use the Widget Settings API to set up schedules defining when the AI assistant or Wix users are available to respond to visitors, control how the chat behaves during AI hours and offline hours, set up welcome messages and suggested questions, configure contact forms, and customize the chat widget's avatar and visual elements.

  • Conversations API: Retrieves conversation information for site visitors. Use the Conversations API to get the conversation ID needed to send and retrieve messages via the Messages API, and check if the conversation has reached your plan's conversation quota.

  • Messages API: Creates and retrieves messages exchanged in the Wix AI Site-Chat between site visitors and the chat system. Use the Messages API to create and send messages from Wix users to site visitors in the chat, access all messages for a site visitor to understand conversation context, create multiple messages efficiently using bulk operations, and build custom integrations that extend the chat functionality.

These APIs work together to enable complete chat solutions: configure behavior with the Widget Settings API, retrieve conversation IDs with the Conversations API, and exchange messages with the Messages API. When a visitor asks a question (QUESTION message type), the AI assistant can automatically respond (ANSWER message type) based on configured availability and behavior settings.

Note: The Wix AI Site-Chat app is currently available only in the Wix Editor.

Learn more about configuring the settings for a Wix AI Site-Chat.

Before you begin

Before you start coding, note the following:

  • A site using these APIs must have the Wix AI Site-Chat app installed. Learn more about adding and setting up Wix AI Site-Chat.
  • The Conversations API and Messages API methods must be called using the site visitor or site member identities to identify the site visitor creating or retrieving messages and conversations.

How the APIs work together

These APIs are designed to work together to provide a complete chat solution:

  1. First, use the Widget Settings API to set up how your chat behaves, when it's available, and what messages visitors see.

  2. Once configured, site visitors can start conversations. Each visitor gets a unique conversation ID that you can retrieve using the Conversations API.

  3. Messages flow through the Messages API. When a visitor asks a question (QUESTION message type), the AI assistant can automatically respond (ANSWER message type) based on configured availability and behavior settings, or a Wix user can send a response.

  4. Call the Messages API to review message history and ensure visitors receive responses.

Use cases

Terminology

Did this help?