POST
/
api
/
lipsyncs_v2
/
preview
/

About preview Field in the Response

The preview field provides a link to preview the video. This link allows you to preview the video before rendering it, you can put it in an iframe to show the video in your application. Example: The preview field in the response will look like this:

"https://app.creatify.ai/preview?layout=videos/20241024/f0c1e1f1-be05-48e0-91d8-3d26ed633d5b.json"

Authorizations

X-API-ID
string
headerrequired

API ID, from your settings page.

X-API-KEY
string
headerrequired

API Key, from your settings page.

Body

video_inputs
object[]
required
aspect_ratio
enum<string>
default: 9x16
  • 9x16 - 9X16
  • 16x9 - 16X9
  • 1x1 - 1X1
Available options:
9x16,
16x9,
1x1
background_music
object

Background music settings.

webhook_url
string

Response

200 - application/json
id
string
required
output
string | null
required
created_at
string
required
updated_at
string
required
progress
number
required
failed_reason
string | null
required
status
enum<string>
required
  • pending - Pending
  • in_queue - In Queue
  • running - Running
  • failed - Failed
  • done - Done
  • rejected - Rejected
Available options:
pending,
in_queue,
running,
failed,
done,
rejected
preview
string | null
required

Preview video

name
string | null
Maximum length: 255
media_job
string | null
webhook_url
string | null
Maximum length: 200