List Avatar Videos (v1)

FreshGET

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

Retrieve a list of all avatar video tasks created under your account. Optionally filter by specific IDs.

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'

With ID filter:

curl -X GET 'https://api.creatify.ai/api/lipsyncs/?ids=abc123,def456' \
  -H 'X-API-ID: your-api-id' \
  -H 'X-API-KEY: your-api-key'

Response

Returns an array of lipsync objects.

[
  {
    "id": "abc123",
    "status": "done",
    "text": "Hello, welcome to our product demo.",
    "creator_id": "avatar-001",
    "aspect_ratio": "16:9",
    "output": "https://cdn.creatify.ai/videos/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

Use the ids parameter to retrieve specific items rather than listing all, which improves performance for large workspaces.