Get Avatar Video (v1)

FreshGET

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

Retrieve a specific avatar video task by its ID. Use this to check the status and output of a creation task.

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/abc123/' \
  -H 'X-API-ID: your-api-id' \
  -H 'X-API-KEY: your-api-key'

Response

{
  "id": "abc123",
  "status": "done",
  "text": "Hello, welcome to our product demo.",
  "creator_id": "avatar-001",
  "aspect_ratio": "16:9",
  "voice_id": "voice-en-001",
  "no_caption": false,
  "output": "https://cdn.creatify.ai/videos/abc123.mp4",
  "preview": "https://cdn.creatify.ai/previews/abc123.mp4",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:35:00Z"
}

Response Fields

Field	Type	Description
id	string	Unique task identifier
status	string	Task status: pending, processing, done, failed
text	string	The script text
creator_id	string	Avatar ID used
aspect_ratio	string	Video aspect ratio
voice_id	string	Voice ID used
no_caption	boolean	Whether captions are disabled
output	string	Final rendered video URL (available when status is done)
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

TIP

Poll this endpoint to check task completion. When status changes to done, the output field will contain the video URL.