# Quickstart

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

### How to Embed your Mascot

Embedding your Hallway.ai widget is a two-part process: first, you'll create your AI character, and then you'll add a simple code snippet to your website.

***

#### 1. Create Your AI Character

<figure><img src="/files/0xC8ZL8Mq7WU7n3E8rZG" alt=""><figcaption></figcaption></figure>

1. Navigate to the Hallway.ai character creation page at <https://hallway.ai/create>.
2. Choose your character's visual style and voice. If you need more advanced options, you can request a premium character or voice by visiting <https://hallway.ai/enterprise>.
3. Give your character a name.
4. Select a role (such as "B2B rep" or "Thought Leader") and define its qualities (like "friendly," "direct," or "curious") to give it a personality.
5. After your character is created, you will be taken to its dedicated dashboard. You can always view all of your characters at <https://hallway.ai/dash/characters> after logging in.

***

#### 2. Embed the Widget on Your Website

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

1. From your character's dashboard, click on the Embed tab.
2. Locate the code snippet provided. It will look like this:

   HTML

   ```
    <hallway-embed character-id="YOUR_CHARACTER_ID"></hallway-embed>
    <script src="https://hallway.ai/embed-loader.js" async type="text/javascript"></script>
   ```
3. The `character-id` in the snippet is unique to your character. The embed dashboard at `https://hallway.ai/<yourCharacterHandle>/embed` provides the snippet with your character ID pre-filled.
4. You can always view all of your characters at <https://hallway.ai/dash/characters> after logging in.
5. Copy the entire code snippet and paste it into the HTML of the webpage where you want the widget to appear. For best performance, it's recommended to place this code just before the closing `</body>` tag.

Your Hallway.ai widget should now be live on your website!

<div data-full-width="false"><figure><img src="/files/5NS85iHwhESgGA1b80ZN" alt=""><figcaption></figcaption></figure></div>

***

3. Advanced Embedding Options For more complicated embedding examples and customization, you can find additional resources at the official Hallway.ai GitHub repository:

<https://github.com/Hallway-Inc/voice-bot-examples>

Your Hallway.ai widget should now be live on your website! 🚀


---

# 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://hallway.gitbook.io/embed/getting-started/quickstart.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.