GET
/
api
/
lipsyncs_v2
/
cURL
curl --request GET \
  --url https://api.creatify.ai/api/lipsyncs_v2/ \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "output": "<string>",
    "video_thumbnail": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "credits_used": 123,
    "duration": 123,
    "progress": "<string>",
    "failed_reason": "<string>",
    "media_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>",
    "webhook_url": "<string>",
    "preview": "<string>",
    "editor_url": "<string>",
    "aspect_ratio": "16x9",
    "video_inputs": [
      "<any>"
    ]
  }
]

Authorizations

​
X-API-ID
string
header
required

API ID, from your settings page.

​
X-API-KEY
string
header
required

API Key, from your settings page.

Query Parameters

​
ids
string

Comma-separated list of UUIDs to filter. Maximum 100 entries allowed.

Minimum length: 1

Response

200 - application/json
​
id
string<uuid>
required
​
output
string | null
required

Output video

​
video_thumbnail
string<uri>
required

Generated Video Thumbnail URL

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
credits_used
integer
required

Credits used in this API call

​
duration
integer
required

Duration of the video in seconds

​
progress
string
required
​
failed_reason
string | null
required

The reason for failure, if the lipsync request failed

​
status
string
required

Status of the lipsync request

​
preview
string | null
required

Preview video

​
editor_url
string | null
required

Editor URL for the video. Expires in 24 hours. Available only if your API account has API editor access enabled.

​
aspect_ratio
enum<string>
required

The aspect ratio of the video

  • 16x9 - Ratio 16 9
  • 1x1 - Ratio 1 1
  • 9x16 - Ratio 9 16
Available options:
16x9,
1x1,
9x16
​
video_inputs
any[]
required
​
name
string | null

The name of the lipsync request.

Maximum length: 255
​
media_job
string<uuid> | null

The media job associated with the lipsync request.

​
webhook_url
string<uri> | null

The webhook URL to be called upon completion of the lipsync request

Maximum length: 200