> ## Documentation Index
> Fetch the complete documentation index at: https://docs.deepreel.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Explore our Guides and API Reference to get the most out of DeepReel.

DeepReel’s API allows you convert text in to talking AI avatar videos. Use the state-of-the-art AI models to create realistic talking videos.

# Requirements

This guide will help you get started with [DeepReel](https://www.deepreel.com). We will cover everything, starting with
creating an account, and then moving on to generating a video.

### Create DeepReel account

[Sign Up for a DeepReel Account](https://beta.deepreel.com/). Once you register with DeepReel, you gain the ability to produce
professional avatar videos using the advanced AI technology of DeepReel. Start your journey in personalized video creation with
DeepReel.

<Note>
  The DeepReel API is exclusively accessible to users subscribed to a paid plan.
  To utilize the DeepReel API, you need to have an active subscription to one of
  the non-free plans. You can create and subscribe to a paid plan here:
  [https://beta.deepreel.com](https://beta.deepreel.com)
</Note>

### Create an API key

After registering your DeepReel account, in the bottom left corner click on your `Account` → `profile` to navigate to the
account settings.
Here, you can activate your API key to unlock access to the DeepReel API. Click on the eye icon on your profile to
access your api key.

<Warning>
  If an unauthorised person gains access to your API Key they will be able use
  your account and credits. Keep it somewhere safe and don't share it with
  anyone.
</Warning>

<Note>
  You can generate a new API Key any time by clicking on the refresh icon.
  Please note that generating a new API Key will invalidate your old API Key.
</Note>

<Frame>
  <img src="https://mintcdn.com/deepreel/FE8Oo3wyOUZySJyx/images/missing.png?fit=max&auto=format&n=FE8Oo3wyOUZySJyx&q=85&s=c6415858e3279fc7a48a5a6d867b88ba" width="309" height="163" data-path="images/missing.png" />
</Frame>

### Configuring Webhook (Optional)

You have the option to set up webhook endpoints that respond to events from DeepReel. Just go to your account page on
DeepReel to configure your webhook settings easily.

<Frame>
  <img src="https://mintcdn.com/deepreel/FE8Oo3wyOUZySJyx/images/missing.png?fit=max&auto=format&n=FE8Oo3wyOUZySJyx&q=85&s=c6415858e3279fc7a48a5a6d867b88ba" width="309" height="163" data-path="images/missing.png" />
</Frame>

For advanced webhook configuration, explore our [webhook API guide](/webhook/overview).

## Create Your First Video

<Snippet file="generate-video.mdx" />

### Checking the status of the Video

<Snippet file="checking-video-status.mdx" />

### Download the video

<Snippet file="download-video.mdx" />

## Create Your Avatar

<Snippet file="create_avatar.mdx" />

## Conclusion

For an in-depth understanding of DeepReel's APIs and their functionalities, we recommend reviewing
our [API reference](/api-reference/).

In conclusion, the DeepReel API enables you to harness the exceptional AI capabilities of DeepReel
for the programmatic creation of captivating avatar videos. By setting up a DeepReel account, acquiring an API key,
and optionally setting up webhooks, you're well-equipped to start your journey in video creation. Discover the
extensive possibilities of DeepReel APIs to inject creativity into your endeavors, whether they're for educational,
entertainment, or marketing purposes.