Get Avatar Video (v2)

FreshGET

GET https://api.creatify.ai/api/lipsyncs/{id}/

Retrieve a specific v2 avatar video task by its ID. V2 tasks include multi-scene data with per-scene avatar, voice, text, and background settings.

Path Parameters

Name	Type	Required	Description
id	string	Yes	The lipsync task ID

Headers

Header	Type	Required	Description
X-API-ID	string	Yes	Your Creatify API ID
X-API-KEY	string	Yes	Your Creatify API key

Example Request

curl -X GET 'https://api.creatify.ai/api/lipsyncs/v2-abc123/' \
  -H 'X-API-ID: your-api-id' \
  -H 'X-API-KEY: your-api-key'

Response

{
  "id": "v2-abc123",
  "status": "done",
  "scenes": [
    {
      "avatar": "avatar-001",
      "voice_id": "voice-en-001",
      "text": "Welcome to our product.",
      "background": "https://example.com/bg1.jpg"
    },
    {
      "avatar": "avatar-002",
      "voice_id": "voice-en-002",
      "text": "Let me show you the features.",
      "background": "https://example.com/bg2.jpg"
    }
  ],
  "aspect_ratio": "16:9",
  "output": "https://cdn.creatify.ai/videos/v2-abc123.mp4",
  "preview": "https://cdn.creatify.ai/previews/v2-abc123.mp4",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:40:00Z"
}

Response Fields

Field	Type	Description
id	string	Unique task identifier
status	string	Task status: pending, processing, done, failed
scenes	array	Array of scene objects
scenes[].avatar	string	Avatar ID for this scene
scenes[].voice_id	string	Voice ID for this scene
scenes[].text	string	Script text for this scene
scenes[].background	string	Background image/video URL
aspect_ratio	string	Video aspect ratio
output	string	Final rendered video URL
preview	string	Preview video URL
created_at	string	ISO 8601 timestamp
updated_at	string	ISO 8601 timestamp

Status Codes

Code	Description
200	Success
401	Unauthorized -- invalid API credentials
404	Lipsync task not found
500	Internal server error