> ## Documentation Index
> Fetch the complete documentation index at: https://docs.creatify.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Use Case: Create Transparent Avatar Videos in WebM Format
> End-to-end guide to generate an avatar video with a transparent background in WebM format using the Creatify API.
# Create Transparent Avatar Videos in WebM Format
This use case shows how to generate an **avatar video with a transparent background** in **WebM** format (alpha channel) using Creatify’s API.\
Perfect for overlaying an avatar on webpages, product demos, games, or editors without a background box.
Here’s an example of a generated transparent WebM avatar video:
***
***
## 🪄 Step 1: Create a Transparent Avatar Video
Send the script, choose an avatar, set your aspect ratio, and turn on transparency.
[`POST /api/lipsyncs/`](/api-reference/lipsyncs/post-apilipsyncs)
```bash Example Request theme={null}
curl --request POST \
--url https://api.creatify.ai/api/lipsyncs/ \
--header 'Content-Type: application/json' \
--header 'X-API-ID: ' \
--header 'X-API-KEY: ' \
--data '{
"text": "Welcome to Creatify AI! Just enter your script, choose an avatar, and generate your video.",
"creator": "18fccce8-86e7-5f31-abc8-18915cb872be",
"aspect_ratio": "9:16",
"transparent_background": true
}'
```
```json Example Response [expandable] theme={null}
{
"id": "df718ed7-d5e8-4261-b610-5a1b8232d105",
"name": null,
"text": "Welcome to Creatify AI! Just enter your script, choose an avatar, and generate your video.",
"creator": "18fccce8-86e7-5f31-abc8-18915cb872be",
"model_version": "standard",
"output": null,
"video_thumbnail": null,
"aspect_ratio": "9x16",
"green_screen": false,
"transparent_background": true,
"created_at": "2025-10-28T20:41:19.607186-07:00",
"updated_at": "2025-10-28T20:41:19.607202-07:00",
"credits_used": 0,
"duration": null,
"progress": 0,
"failed_reason": null,
"media_job": null,
"status": "pending",
"is_hidden": false,
"audio_url": null,
"webhook_url": null,
"accent": null,
"preview": null,
"editor_url": null,
"preview_audio": null,
"no_caption": true,
"no_music": true,
"caption_style": "normal-black",
"caption_offset_x": "0.00",
"caption_offset_y": "-0.40"
}
```
> ✅ The generated WebM includes an **alpha channel**, so the background is fully transparent.
***
## ⏳ Step 2: Check Video Generation Status
After submitting a video generation request, use the returned **task ID** to monitor progress and retrieve the completed video when it’s ready.
[`GET /api/lipsyncs/{id}/`](/api-reference/lipsyncs/get-apilipsyncs-)
```bash Example Request theme={null}
curl --request GET \
--url https://api.creatify.ai/api/lipsyncs/4c0b2b3c-dcbb-4c12-8e98-a1e0643d5394 \
--header 'X-API-ID: ' \
--header 'X-API-KEY: '
```
```json Example Response [expandable] theme={null}
{
"id": "df718ed7-d5e8-4261-b610-5a1b8232d105",
"name": null,
"text": "Welcome to Creatify AI! Just enter your script, choose an avatar, and generate your video.",
"creator": "18fccce8-86e7-5f31-abc8-18915cb872be",
"model_version": "standard",
"output": "https://dpbavq092lwjh.cloudfront.net/lipsync/20251029/df718ed7-d5e8-4261-b610-5a1b8232d105/result.webm",
"video_thumbnail": null,
"aspect_ratio": "9x16",
"green_screen": false,
"transparent_background": true,
"created_at": "2025-10-28T20:41:19.607186-07:00",
"updated_at": "2025-10-28T20:42:17.447750-07:00",
"credits_used": 5,
"duration": 4,
"progress": 1,
"failed_reason": null,
"media_job": "1749c5ae-1078-4c2d-ab2a-aee349147635",
"status": "done",
"is_hidden": false,
"audio_url": null,
"webhook_url": null,
"accent": null,
"preview": "https://app.creatify.ai/preview?layout=videos/20251028/a88a1b12-dc19-43e8-a8b8-111247872b2d.json",
"editor_url": null,
"preview_audio": "https://d35ghwdno3nak3.cloudfront.net/user/18165/2025-10-28/67d6-req-rFB9UwcpSgFDviEHZwJC-0-s.mp3",
"no_caption": true,
"no_music": true,
"caption_style": "normal-black",
"caption_offset_x": "0.00",
"caption_offset_y": "-0.40",
"word_alignments": []
}
```
> ⏳ Once the **status** is `done`, download your video from the `output` field.
> You can embed or download the file and overlay the avatar on any background in your app or editor.
***
## 💡 Tips
* **Player support:** Ensure your player/environment supports **WebM with alpha** so transparency appears correctly.
* **Overlay use:** Place the WebM on top of other UI layers for dynamic, background-free avatars.
* **Sizing:** Match `aspect_ratio` to your target layout (e.g., `9:16` for vertical, `16:9` for landscape).
***
## ✅ Summary of Endpoints
| Step | Endpoint | Description |
| ---- | --------------------- | ------------------------------- |
| 1 | `/api/lipsyncs/` | Create transparent avatar video |
| 2 | `/api/lipsyncs/{id}/` | Check video generation status |