Embedding Assistants

Introduction

You may place your assistant on any website such as your landing page, support page or any other where the assistant may help you & your users. Embedded assistant will combine specific model, tools, instructions and configuration to provide out-of-the-box chat experience with specific focus, capabilities, knowledge and scope - learn more on the  Working With Assistants page.

TaskLift allows to get started with a nice chat bubble or chatbox experience in minutes by providing a tiny HTML snippet for placement in your page markup.

At the same time you have infinite flexibility when it comes to customizing the assistant - you can both customize our embed's theme or roll out your own e.g. by using any chatbot library compatible with OpenAI API (learn more on the  Chatting Over API page).

When it comes to security, TaskLift gives you a choice between:

• shared assistant with billing covered - useful if you want to place the assistant on a public page (learn more about assistant sharing on the  Sharing Assistants page)
• protected assistant authorized with API key - useful if you want to control the access (learn more about API access to chat assistants on the  Chatting Over API page)

You may preview all the chats that were done for given embedded assistant by visiting the Assistants section, opening the given assistant's chat and toggling the chat history via the History button.

TaskLift Script

TaskLift embed script is the simplest way to get your white-label assistant out there. We provide an out-of-the-box script that can be generated and customized on a dedicated page, you copy & paste it into your website's markup and that's it.

To get started, just visit the Assistants section and click the Embed button - either on the top of the page or next to specific assistant. This will take you to the assistant embed page where you may preview, customize and grab the code for your embed. Among others you will see options to configure following aspects of your embedded assistant:

• Layout - allows to pick normal container or floating chat bubble
• Theme - allows to pick system default, light or dark theme
• Theme Customization - allows to override all colors for text, background etc

Note that if your assistant is not shared, you will see an additional field to enter the API key that you choose to use for this embed. You may visit the API Keys section in your profile menu to grab or create this key. Non-shared assistant won't work without this key, even for the preview. Keep in mind that the provided key will be included within the embed so it should be managed with caution.

Custom Script

If you need something different than our script provides, you may decide to go for ultimate customization and roll out your own assistant by taking advantage of the Chat Completion API provided by TaskLift.

This API is compatible with the widely adopted OpenAI API standard and will work from the browser (either without authorization for shared assistants or with API key for non-shared assistants) so you may either use an existing OpenAI-compatible library (e.g. DeepChat) or write your own JS code.

Learn more about our API and its usage with chat assistants on the  Chatting Over API page.