Embed SDK

​

Overview

Our Embed SDK lets you interact with TeamAI chatbots embedded on your web pages. It provides methods to update context and retrieve current context, giving you full control over your embedded chatbots.

​

Methods

​

Initialize Embed SDK

The SDK automatically initializes when the chatbot is embedded on your page. You don’t need to call an explicit init function.

​

Get Chatbot Instance

Retrieves an instance of the chatbot for interaction.

const chatbotInstance = tai.getInstance("YOUR_ASSISTANT_ID");

This method returns a chatbot instance that you can use to interact with your embedded chatbot.

​

Wait for Chatbot Ready State

window.addEventListener("teamAIChatbotReady", function () {
  const chatbotInstance = tai.getInstance("YOUR_ASSISTANT_ID");
  // Your code here
});

​

Update Chatbot Context

Updates the context for your chatbot.

chatbotInstance.updateContext({ userEmail: "user@example.com" });

This method allows you to update the context for the chatbot dynamically. You can use these context variables in your assistant’s instructions like so: {{userEmail}}.

​

Get Chatbot Context

Retrieves the current context of the chatbot.

const currentContext = chatbotInstance.getContext();

This method returns the current context of the chatbot.

​

Example: Updating Context

In this example, we’re setting up the chatbot and updating the context with the user’s email and name.

window.addEventListener("teamAIChatbotReady", function () {
  console.log('The TeamAI Chatbot is ready!');

  const chatbotInstance = tai.getInstance("YOUR_ASSISTANT_ID");

  // Update context with user's email and name
  chatbotInstance.updateContext({
    "userEmail": "user@example.com",
    "userName": "John Doe"
  });
});

This example demonstrates how to set up the chatbot, log its readiness, and update its context programmatically.

​

Debug Mode

To enable debug mode in TeamAI, add ?teamAIDebug=true to your app’s URL.

For example, if you’ve embedded your TeamAI instance in your app hosted at https://example.com, you can activate debug mode by changing the URL to:

https://example.com?teamAIDebug=true

After adding this parameter, refresh the page and open your browser’s developer console (usually by pressing F12 or right-clicking and selecting “Inspect” then navigating to the “Console” tab).