Coding Examples

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

Picasso

GraphQL (Alpha)

Conversations

Conversations 1 0 0

Retrieves the conversation for the site visitor calling this method.

This method must be called using the site visitor or site member identity ([SDK](https://dev.wix.com/docs/sdk/articles/get-started/about-identities#site-member) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/about-identities#site-member)) to identify the site visitor that is requesting the conversation.

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

async function getConversation() {
  const response = await conversations.getConversation();
};

getConversation: Wix-hosted

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


async function myGetConversationMethod() {
  const response = await myWixClient.conversations.myGetConversationMethod();
};

getConversation: (with elevated permissions)

import { createClient } from '@wix/sdk';
import { conversations } 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: { conversations },
  // Include the auth strategy and host as relevant
});


async function getConversation() {
  const response = await myWixClient.conversations.getConversation();
};

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).

getConversation: Self-hosted

getConversation

GetConversationResponse

Retrives the conversation usage and quota for the site.

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

async function getConversationsUsage() {
  const response = await conversations.getConversationsUsage();
};

getConversationsUsage: Wix-hosted

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


async function myGetConversationsUsageMethod() {
  const response = await myWixClient.conversations.myGetConversationsUsageMethod();
};

getConversationsUsage: (with elevated permissions)

import { createClient } from '@wix/sdk';
import { conversations } 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: { conversations },
  // Include the auth strategy and host as relevant
});


async function getConversationsUsage() {
  const response = await myWixClient.conversations.getConversationsUsage();
};

getConversationsUsage: Self-hosted

getConversationsUsage

GetConversationsUsageResponse

# About the Conversations API

The Conversations API enables you to retrieve conversation information for a site's AI Site-Chat.

With this API, you can:
- Retrieve the conversation details for a site visitor.
- Retrieve a site's total conversation stats, including the [quota](https://support.wix.com/en/article/your-ai-chat-assistant-conversations-quota) for the current plan.

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

## Use cases
- [Reduce the AI assistant's active hours if the quota has nearly been reached](https://dev.wix.com/docs/sdk/backend-modules/ai-site-chat/conversations/sample-flows##reduce-the-ai-assistants-active-hours-if-the-quota-has-nearly-been-reached)

@package_metadata:@wix/ai-site-chat

To use the Conversations API, install the `@wix/ai-site-chat` package.

### Install the package
To install the package, follow the instructions below based on your development environment.

#### Wix sites and Blocks apps
When developing with:
 - Editor or Wix IDE: Use the [package manager](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-in-the-editor).
 - Local IDE: Use the [Wix CLI](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-with-the-wix-cli). Run the following command:
  ```console
npm install @wix/ai-site-chat
```

or

```console
yarn add @wix/ai-site-chat
```


#### Wix apps and Headless
When developing CLI or self-hosted Wix apps, as well as headless apps or sites, run the following command:
  ```console
npm install @wix/ai-site-chat
```

or

```console
yarn add @wix/ai-site-chat
```

#### Import the package

To import the package in your code:

```js
import { conversations } from '@wix/ai-site-chat'
```
  

# Conversations: Sample Use Cases and Flows

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

## Reduce the AI assistant's active hours if the quota has nearly been reached
To reduce the AI assistant's active hours if the quota has nearly been reached:

1. Call [Get Conversation Usage](https://dev.wix.com/docs/sdk/backend-modules/ai-site-chat/conversations/get-conversations-usage).
1. In the response, if the value of `current` is greater than 80% of `quota`, call [Set Widget Settings](https://dev.wix.com/docs/sdk/backend-modules/ai-site-chat/widget-settings/set-widget-settings) to reduce the AI assistant's active hours.