POST
/
api
/
link_to_videos
/
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://video.creatify.ai/preview?layout=videos/20240808/abd7ac2e-471a-4f0c-b2b2-a4e6580c61f9.json"

​
About override_avatar parameter

When using ‘create video from link’ API, if the ‘override_avatar’ (avatar_id is passed in the parameters, we will use it as the avatar of the video. If the ‘override_avatar’ is not passed, we will use the matched avatar for the video.

avatar_id is the unique identifier of an avatar. You can get the avatar_id by calling the Get avatar endpoint.

​
About override_voice parameter

When using ‘create video from link’ API, if the ‘override_voice’ is passed in the parameters, we will use it for the voiceover of the video. If the ‘override_voice’ is not passed, we’ll use the matched voice (from the avatar) for the video.

voice_id is the unique identifier of the voice. You can get the voice_id by calling the Get voices interface.

Tips: foreach voice has multiple accents, you can choose one from the accents as the voice of the video.

Authorizations

X-API-ID
string
headerrequired

API ID, from your settings page.

X-API-KEY
string
headerrequired

API Key, from your settings page.

Body

link
string
required
name
string | null
Maximum length: 255
target_platform
string
Maximum length: 255
target_audience
string
Maximum length: 255
language
enum<string>
  • ar - Arabic
  • bg - Bulgarian
  • cs - Czech
  • da - Danish
  • de - German
  • el - Greek, Modern
  • en - English
  • es - Spanish; Castilian
  • fi - Finnish
  • fr - French
  • hi - Hindi
  • hr - Croatian
  • id - Indonesian
  • it - Italian
  • ja - Japanese
  • ko - Korean
  • ms - Malay
  • nl - Dutch
  • pl - Polish
  • pt - Portuguese
  • ro - Romanian, Moldavian, Moldovan
  • ru - Russian
  • sk - Slovak
  • sv - Swedish
  • ta - Tamil
  • tl - Tagalog
  • tr - Turkish
  • uk - Ukrainian
  • zh - Chinese
Available options:
ar,
bg,
cs,
da,
de,
el,
en,
es,
fi,
fr,
hi,
hr,
id,
it,
ja,
ko,
ms,
nl,
pl,
pt,
ro,
ru,
sk,
sv,
ta,
tl,
tr,
uk,
zh
video_length
enum<integer>
  • 15 - 15
  • 30 - 30
  • 60 - 60
Available options:
15,
30,
60
aspect_ratio
enum<string>
  • 16x9 - 16x9
  • 1x1 - 1x1
  • 9x16 - 9x16
Available options:
16x9,
1x1,
9x16
script_style
enum<string>
  • DiscoveryWriter - Discovery
  • DontWorryWriter - Don't Worry
  • EmotionalWriter - Emotional
  • GenzWriter - Gen Z
  • LetMeShowYouWriter - Let Me Show You
  • MotivationalWriter - Motivational
  • NarrationWriter - Music Starter
  • ProblemSolutionWriter - Problem-Solution
  • ResponseBubbleWriter - Response Bubble
  • StoryTimeWriter - Storytime
  • ThreeReasonsWriter - 3 Reasons Why
  • DIY - DIY
Available options:
DiscoveryWriter,
DontWorryWriter,
EmotionalWriter,
GenzWriter,
LetMeShowYouWriter,
MotivationalWriter,
NarrationWriter,
ProblemSolutionWriter,
ResponseBubbleWriter,
StoryTimeWriter,
ThreeReasonsWriter,
DIY
visual_style
enum<string>
  • AvatarBubbleTemplate - Avatar Bubble
  • DramaticTemplate - Dramatic
  • DynamicProductTemplate - Product
  • DynamicResponseBubbleTemplate - Response Bubble
  • FullScreenTemplate - Full Screen
  • GreenScreenEffectTemplate - Green Screen Effect
  • MotionCardsTemplate - Motion Cards
  • OverCardsTemplate - Over Cards
  • QuickTransitionTemplate - Quick Transition
  • ScribbleTemplate - Scribble
  • SideBySideTemplate - Side by Side
  • TopBottomTemplate - Top & Bottom
  • TwitterFrameTemplate - Twitter Frame
  • VanillaTemplate - Vanilla
  • VlogTemplate - Vlog
Available options:
AvatarBubbleTemplate,
DramaticTemplate,
DynamicProductTemplate,
DynamicResponseBubbleTemplate,
FullScreenTemplate,
GreenScreenEffectTemplate,
MotionCardsTemplate,
OverCardsTemplate,
QuickTransitionTemplate,
ScribbleTemplate,
SideBySideTemplate,
TopBottomTemplate,
TwitterFrameTemplate,
VanillaTemplate,
VlogTemplate
override_avatar
string | null
Maximum length: 255
override_voice
string | null
Maximum length: 255
override_script
string | null
webhook_url
string | null
Maximum length: 200
no_background_music
boolean
no_caption
boolean
no_emotion
boolean
caption_style
enum<string>
  • 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_position

Position of the caption, only center is supported for now, default to null

  • center - Center
Available options:
center
caption_offset_x
string | null

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

caption_offset_y
string | null

Caption offset y is vertically relative to the center of the canvas in percentage, range from -0.5 to 0.5, default to null

Response

200 - application/json
id
string
required
link
string
required
media_job
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
failed_reason
string | null
required
is_hidden
boolean
required
video_output
string | null
required
credits_used
integer | null
required
progress
string
required
preview
string | null
required
name
string | null
Maximum length: 255
target_platform
string
Maximum length: 255
target_audience
string
Maximum length: 255
language
enum<string>
  • ar - Arabic
  • bg - Bulgarian
  • cs - Czech
  • da - Danish
  • de - German
  • el - Greek, Modern
  • en - English
  • es - Spanish; Castilian
  • fi - Finnish
  • fr - French
  • hi - Hindi
  • hr - Croatian
  • id - Indonesian
  • it - Italian
  • ja - Japanese
  • ko - Korean
  • ms - Malay
  • nl - Dutch
  • pl - Polish
  • pt - Portuguese
  • ro - Romanian, Moldavian, Moldovan
  • ru - Russian
  • sk - Slovak
  • sv - Swedish
  • ta - Tamil
  • tl - Tagalog
  • tr - Turkish
  • uk - Ukrainian
  • zh - Chinese
Available options:
ar,
bg,
cs,
da,
de,
el,
en,
es,
fi,
fr,
hi,
hr,
id,
it,
ja,
ko,
ms,
nl,
pl,
pt,
ro,
ru,
sk,
sv,
ta,
tl,
tr,
uk,
zh
video_length
enum<integer>
  • 15 - 15
  • 30 - 30
  • 60 - 60
Available options:
15,
30,
60
aspect_ratio
enum<string>
  • 16x9 - 16x9
  • 1x1 - 1x1
  • 9x16 - 9x16
Available options:
16x9,
1x1,
9x16
script_style
enum<string>
  • DiscoveryWriter - Discovery
  • DontWorryWriter - Don't Worry
  • EmotionalWriter - Emotional
  • GenzWriter - Gen Z
  • LetMeShowYouWriter - Let Me Show You
  • MotivationalWriter - Motivational
  • NarrationWriter - Music Starter
  • ProblemSolutionWriter - Problem-Solution
  • ResponseBubbleWriter - Response Bubble
  • StoryTimeWriter - Storytime
  • ThreeReasonsWriter - 3 Reasons Why
  • DIY - DIY
Available options:
DiscoveryWriter,
DontWorryWriter,
EmotionalWriter,
GenzWriter,
LetMeShowYouWriter,
MotivationalWriter,
NarrationWriter,
ProblemSolutionWriter,
ResponseBubbleWriter,
StoryTimeWriter,
ThreeReasonsWriter,
DIY
visual_style
enum<string>
  • AvatarBubbleTemplate - Avatar Bubble
  • DramaticTemplate - Dramatic
  • DynamicProductTemplate - Product
  • DynamicResponseBubbleTemplate - Response Bubble
  • FullScreenTemplate - Full Screen
  • GreenScreenEffectTemplate - Green Screen Effect
  • MotionCardsTemplate - Motion Cards
  • OverCardsTemplate - Over Cards
  • QuickTransitionTemplate - Quick Transition
  • ScribbleTemplate - Scribble
  • SideBySideTemplate - Side by Side
  • TopBottomTemplate - Top & Bottom
  • TwitterFrameTemplate - Twitter Frame
  • VanillaTemplate - Vanilla
  • VlogTemplate - Vlog
Available options:
AvatarBubbleTemplate,
DramaticTemplate,
DynamicProductTemplate,
DynamicResponseBubbleTemplate,
FullScreenTemplate,
GreenScreenEffectTemplate,
MotionCardsTemplate,
OverCardsTemplate,
QuickTransitionTemplate,
ScribbleTemplate,
SideBySideTemplate,
TopBottomTemplate,
TwitterFrameTemplate,
VanillaTemplate,
VlogTemplate
override_avatar
string | null
Maximum length: 255
override_voice
string | null
Maximum length: 255
override_script
string | null
webhook_url
string | null
Maximum length: 200
no_background_music
boolean
no_caption
boolean
no_emotion
boolean
caption_style
enum<string>
  • 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_position

Position of the caption, only center is supported for now, default to null

  • center - Center
Available options:
center
caption_offset_x
string | null

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

caption_offset_y
string | null

Caption offset y is vertically relative to the center of the canvas in percentage, range from -0.5 to 0.5, default to null

Get video historyRender video