# Welcome

## **Welcome to the Official Convai Documentation** 

Your platform for building, customizing, and deploying intelligent, interactive AI characters across various environments and platforms.

Whether you’re a **developer**, **designer**, or **creator**, this documentation will guide you through every step from your first login to building fully immersive experiences with Convai’s powerful tools and integrations.

<figure><img src="https://413558230-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEtUJA212Zc1S9ACc8T4l%2Fuploads%2FduhSyeytuVBQ9zJHawuS%2FScreenshot%202025-08-11%20151646.png?alt=media&#x26;token=c9605025-d6a3-43c5-b79d-322ac78b614d" alt=""><figcaption></figcaption></figure>

***

## What You’ll Find Here

Our documentation is divided into several sections so you can easily find what you need:

### 1. Convai Playground

Learn to create, customize, and test your AI characters directly in Convai Playground.

* [**Get Started**](https://docs.convai.com/api-docs/convai-playground/get-started) – Basics of navigating the dashboard, creating your first character, and testing interactions.
* [**Character Customization**](https://docs.convai.com/api-docs/convai-playground/character-customization) – Deep dive into the tools for defining your character’s appearance, voice, knowledge, traits, and more.

### 2. No Code Experiences

Create interactive AI experiences without writing a single line of code.

* [**Avatar Studio Experiences**](https://docs.convai.com/api-docs/no-code-experiences/avatar-studio-experiences) – Create and customize your character’s visual identity, including appearance, clothing, accessories, environment, animations, lighting, camera angles, and more, all within an easy-to-use no-code editor.
* [**Convai Sim Experiences**](https://docs.convai.com/api-docs/no-code-experiences/convai-sim-experiences) – Build interactive, large-scale simulation environments where your AI characters engage in realistic scenarios, navigate spaces, and interact with objects.
* [**Convai XR Animation Capture App**](https://docs.convai.com/api-docs/no-code-experiences/convai-xr-animation-capture-app) – Capture high-fidelity motion data using your XR device and apply realistic animations to your avatars for more immersive, lifelike performances.

### 3. Plugins & Integrations

Extend your characters into your applications and games.

* [Unity](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin), [Unreal Engine](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine), and [Web Plugins](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins).
* [Modding Frameworks](https://docs.convai.com/api-docs/plugins-and-integrations/modding-framework) and [Other Integration](https://docs.convai.com/api-docs/plugins-and-integrations/other-integrations) options.
* [Convai Pixel Streaming Embed](https://docs.convai.com/api-docs/plugins-and-integrations/convai-pixel-streaming-embed) capabilities.

### 4. API Reference

In-depth [API documentation](https://docs.convai.com/api-docs/api-reference/core-api-reference) for advanced customization and integration.

***

## Before You Begin

To start building with Convai, you only need:

* A **Convai account** – [Sign up here](https://www.convai.com/) if you don’t have one.

***

## Getting Help

* If you can’t find what you’re looking for, use the search bar at the top of the documentation to quickly locate relevant topics.
* For inspiration, check out the **Sample Characters** available in your [Dashboard](https://docs.convai.com/api-docs/convai-playground/get-started/dashboard-overview#main-dashboard-view).
* If you need further assistance, visit the [**Convai Developer Forum**](https://forum.convai.com/) to connect with the community and get support from the Convai team.


---

# 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.convai.com/api-docs/welcome.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.