Skip to content

Create Avatar Video (v1)

FreshPOST
POST https://api.creatify.ai/api/lipsyncs/

Create a new AI avatar lipsync video task. The avatar will speak the provided text using the specified voice.

Credit Cost

5 credits per 30 seconds of video

Request Body

NameTypeRequiredDescription
textstringYesThe script text for the avatar to speak
creator_idstringYesAvatar ID to use (from your avatar library)
aspect_ratiostringNoVideo aspect ratio (e.g., 16:9, 9:16, 1:1). Defaults to 16:9
voice_idstringNoVoice ID from /api/voices/. Uses avatar default if not specified
no_captionbooleanNoSet to true to disable captions. Defaults to false

Headers

HeaderTypeRequiredDescription
X-API-IDstringYesYour Creatify API ID
X-API-KEYstringYesYour Creatify API key
Content-TypestringYesapplication/json

Example Request

bash
curl -X POST 'https://api.creatify.ai/api/lipsyncs/' \
  -H 'X-API-ID: your-api-id' \
  -H 'X-API-KEY: your-api-key' \
  -H 'Content-Type: application/json' \
  -d '{
    "text": "Welcome to our product demo. Today we will show you how easy it is to get started.",
    "creator_id": "avatar-001",
    "aspect_ratio": "16:9",
    "voice_id": "voice-en-001",
    "no_caption": false
  }'

Response

json
{
  "id": "abc123",
  "status": "pending",
  "text": "Welcome to our product demo. Today we will show you how easy it is to get started.",
  "creator_id": "avatar-001",
  "aspect_ratio": "16:9",
  "voice_id": "voice-en-001",
  "no_caption": false,
  "created_at": "2024-01-15T10:30:00Z"
}

Status Codes

CodeDescription
201Task created successfully
400Bad request -- invalid parameters
401Unauthorized -- invalid API credentials
402Insufficient credits
429Rate limit exceeded
500Internal server error

Workflow

After creating a task:

  1. Poll GET /api/lipsyncs/{id}/ until status is done
  2. Use POST /api/lipsyncs/{id}/preview/ to generate a preview (1 credit/30s)
  3. Use POST /api/lipsyncs/{id}/render/ to render the final video (4 credits/30s)

TIP

Use the voice_id parameter to choose a specific voice. List available voices with GET /api/voices/.