πŸ” We recommend upgrading to the AI Avatar v2 API for greater creative flexibility, including multi-scene composition, custom voices, backgrounds, and fine-grained control over captions and transitions.

πŸš€ Introduction

The AI Avatar API enables you to generate realistic, high-quality videos of virtual people speaking from any text or audio input. Whether you’re building a marketing campaign, a product demo, or an educational assistant, this API offers an intuitive way to bring your content to lifeβ€”powered by customizable personas and simple integration. AI Avatar Snapshot

βš™οΈ Quickstart Guide

βœ… Prerequisites

Before you begin, ensure you have:

πŸ§‘β€πŸŽ€ Step 1: Choose a Persona

We offer 750+ lifelike personas with diverse styles and expressions to match your use case. This API returns a list of available personas, each with a unique id field. Use the id of the selected persona as the creator parameter when generating your video.

πŸ“ Step 2: Submit a Video Generation Request

Use this endpoint to generate a video of a person speaking from text.
curl --request POST \
  --url https://api.creatify.ai/api/lipsyncs/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-ID: your-api-id' \
  --header 'X-API-KEY: your-api-key' \
  --data '{
    "text": "hello world",
    "creator": "18fccce8-86e7-5f31-abc8-18915cb872be",
    "aspect_ratio": "9:16"
}'
⚠️ Save the id β€” you’ll need it to check the status.

⏳ Step 3: 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.
curl --request GET \
  --url https://api.creatify.ai/api/lipsyncs/4c0b2b3c-dcbb-4c12-8e98-a1e0643d5394 \
  --header 'X-API-ID: your-api-id' \
  --header 'X-API-KEY: your-api-key'
⏳ Once the status is done, download the video from the output field.

🎯 Summary

StepEndpoint
List PersonasGET /api/personas/
Create TaskPOST /api/lipsyncs/
Check StatusGET /api/lipsyncs/{id}/
API ReferenceLipsync API Reference

🀝 Need Help?

If you run into any issues, check out our API Reference or contact api@creatify.ai.