List Avatar Videos (v2)

FreshGET

GET https://api.creatify.ai/api/lipsyncs/

Retrieve a list of all v2 avatar video tasks. The v2 API supports multi-scene avatar videos with per-scene customization.

Request Parameters

Name	Type	Required	Description
ids	string	No	Comma-separated list of lipsync IDs to filter by

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

Response

Returns an array of v2 lipsync objects with scene data.

[
  {
    "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"
      }
    ],
    "aspect_ratio": "16:9",
    "output": "https://cdn.creatify.ai/videos/v2-abc123.mp4",
    "created_at": "2024-01-15T10:30:00Z"
  }
]

Status Codes

Code	Description
200	Success
401	Unauthorized -- invalid API credentials
429	Rate limit exceeded
500	Internal server error

TIP

The v2 list endpoint returns both v1 and v2 lipsync tasks. V2 tasks include a scenes array in their response.