Enable the Share button in your Inkeep components.

When clicked, it generates a link to a chat so a user can share with other users.

1

Create a dedicated "View" page

We first need to create a page where the share links will lead to (e.g. https://inkeep.com/ask-ai). This should be a page in your documentation, app, or marketing site that contains the Inkeep Embedded Chat component.

Reference:

Examples:

The Embedded Chat automatically displays any conversation based on if a ?chatId= query parameter is present in the URL of the loading the page it’s embedded in.

2

Configure the Inkeep components

Set the value of aiChatSettings.shareChatUrlBasePath to the URL from the previous step for all Inkeep components you want to enable the Share button for. This can include any Search Bar, Chat Button, or Custom Trigger you use in any site or application.

When clicked, it’ll copy a link to the user’s clipboard in the format of https://{shareChatUrlBasePath}?chatId={sharedChatId}.

Also set aiChatSettings.isChatSharingEnabled to true.

​
Example

import { type InkeepAIChatSettings } from "@inkeep/uikit";

const inkeepAIChatSettings: InkeepAIChatSettings = {
  //... rest of inkeepAIChatSettings
  isChatSharingEnabled: true,
  shareChatUrlBasePath: "https://mydomain.com/ask-ai",
};
Add user authenticationReact