GET
/
api
/
lipsyncs
/
{id}
curl --request GET \
  --url https://api.creatify.ai/api/lipsyncs/{id}/ \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "text": "<string>",
  "creator": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "output": "<string>",
  "video_thumbnail": "<string>",
  "aspect_ratio": "16x9",
  "green_screen": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "credits_used": 123,
  "progress": "<string>",
  "failed_reason": "<string>",
  "media_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "is_hidden": true,
  "audio_url": "<string>",
  "webhook_url": "<string>",
  "accent": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "preview": "<string>",
  "preview_audio": "<string>",
  "no_caption": true,
  "no_music": true,
  "caption_style": "normal-black",
  "caption_offset_x": "<string>",
  "caption_offset_y": "<string>",
  "background_asset_image_url": "<string>"
}

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.

Path Parameters

​
id
string
required

A UUID string identifying this lipsync.

Response

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

Output video

​
video_thumbnail
string
required

Generated Video Thumbnail URL

​
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
​
created_at
string
required
​
updated_at
string
required
​
credits_used
integer
required

Credits used in this api call

​
progress
string
required
​
failed_reason
string | null
required

The reason for failure, if the lipsync request failed

​
media_job
string | null
required

The media job associated with the lipsync request.

​
status
string
required

Status of the lipsync request

​
is_hidden
boolean
required

Is the video hidden in the website projects page

​
audio_url
string | null
required
​
preview
string | null
required

Preview video

​
preview_audio
string | null
required

Preview audio

​
name
string | null

The name of the lipsync request.

Maximum length: 255
​
text
string | null

The text to be used for voiceover

Maximum length: 8000
​
creator
string | null

The creator id associated with the lipsync request, you can get the list of creators from /api/personas endpoint.

​
green_screen
boolean

When true, the background will be transparent and subtitles will not be rendered on the video. Default is false.

​
webhook_url
string | null

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

Maximum length: 200
​
accent
string | null

The avatar id to be used for lipsync, you can get the list of accents from /api/voices endpoint.

​
no_caption
boolean

Whether to include captions in the output video. Default is true, video without caption.

​
no_music
boolean

Whether to include background music in the output video. Default is true, video without music.

​
caption_style
enum<string>

The style of the captions

  • normal-black - NORMAL_BLACK
  • normal-white - NORMAL_WHITE
  • normal-red - NORMAL_RED
  • normal-blue - NORMAL_BLUE
  • neo - NEO
  • brick - BRICK
  • frenzy - FRENZY
  • verana - VERANA
  • mustard - MUSTARD
  • glow - GLOW
  • mint - MINT
  • coolers - COOLERS
  • bilo - BILO
  • toons - TOONS
  • deep-blue - DEEP_BLUE
  • mystique - MYSTIQUE
  • caution - CAUTION
  • duality - DUALITY
Available options:
normal-black,
normal-white,
normal-red,
normal-blue,
neo,
brick,
frenzy,
verana,
mustard,
glow,
mint,
coolers,
bilo,
toons,
deep-blue,
mystique,
caution,
duality
​
caption_offset_x
string

Caption offset x is horizontaly relative to the center of the canvas in percentage, range from -0.5 to 0.5, default to 0

​
caption_offset_y
string

Caption offset y is vertically relative to the center of the canvas in percentage, range from -0.5 to 0.5, default to -0.4, which is 40% below center

​
background_asset_image_url
string

The url of the background asset image

Maximum length: 1024