# Quick Start Guide

## Introduction

This guide will walk you through the simple steps needed to integrate Sentifyd 3D AI avatar into your website or web application. To begin, ensure you have the avatar's API key, which can be found in the Sentifyd platform under the avatar section.

## Preparation: Create an Avatar

Before you can deploy an avatar, you need to create and train it on the Sentifyd platform. Besides, customize the avatar widget using the the customization panel provided in the avatar page. Once done, open the Website Deployment modal from the avatar page.

<figure><img src="/files/CxtSlOPvNsSNQ5BNqekn" alt=""><figcaption></figcaption></figure>

## Step 1: Set Allowed Domain

This is a required step to allow the avatar to be deployed on your website. Add your website domain and click on Save Domain.

<figure><img src="/files/f1E9Zs9Q5R225gduHrYX" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/TKcBvi7SjPcEnjRvOaFn" alt=""><figcaption></figcaption></figure>

## Step 2: Copy the Avatar Embed

Use the provided embed creator to configure and copy your avatar embed.

{% hint style="info" %}

### **Security Note:**

Exposing your avatar API key in the frontend is generally safe. This key is public and only permits interaction with the avatar, and its usage is restricted by the “allowed domains” setting—meaning the avatar cannot be deployed on unauthorized websites.

If you prefer not to expose your avatar API key at all, you can follow our Backend-for-Frontend (BFF) guide to issue short-lived access tokens instead.
{% endhint %}

<figure><img src="/files/uM6xu0QsqC06fVK3Rg3G" alt=""><figcaption></figcaption></figure>

#### Optional: Advanced customization of the Avatar

You can customize your avatar's behavior and appearance using additional attributes in the `<sentifyd-bot>` or `<sentifyd-realtime>` component. For a full list of customization options, please refer to the detailed guide on the `<sentifyd-bot>/ <sentifyd-realtime>` Web Component.

### Step 3 Deploy in your Website

Next, copy and add the avatar embed code in your website wherever you want the avatar to appear. Make sure the script tag is placed in head or at the end of the body element. If you chose the toggler option, the parent size does not matter and avatar will be deployed floating in the page's bottom right corner.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.sentifyd.io/manual-web-integration/quick-start-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.