Get video history

GET

api

link_to_videos

curl --request GET \
  --url https://api.creatify.ai/api/link_to_videos/ \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>'

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "target_platform": "<string>",
    "target_audience": "<string>",
    "language": "ar",
    "video_length": 15,
    "aspect_ratio": "16x9",
    "script_style": "BenefitsV2",
    "visual_style": "AvatarBubbleTemplate",
    "override_avatar": "<string>",
    "override_voice": "<string>",
    "override_script": "<string>",
    "background_music_url": "<string>",
    "background_music_volume": 0.5,
    "voiceover_volume": 0.5,
    "webhook_url": "<string>",
    "link": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "media_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>",
    "failed_reason": "<string>",
    "is_hidden": true,
    "video_output": "<string>",
    "video_thumbnail": "<string>",
    "credits_used": 123,
    "progress": "<string>",
    "no_background_music": true,
    "no_caption": true,
    "no_emotion": true,
    "no_cta": true,
    "no_stock_broll": true,
    "preview": "<string>",
    "previews": [
      {
        "media_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "url": "<string>"
      }
    ],
    "caption_style": "normal-black",
    "caption_offset_x": "<string>",
    "caption_offset_y": "<string>",
    "caption_setting": {
      "style": "normal-black",
      "offset": {
        "x": 0,
        "y": 0.4
      },
      "font_family": "Montserrat",
      "font_size": 123,
      "font_style": "font-bold",
      "background_color": "<string>",
      "text_color": "<string>",
      "highlight_text_color": "<string>",
      "max_width": 123,
      "line_height": 123,
      "text_shadow": "<string>",
      "hidden": false
    },
    "visual_styles": [
      "AvatarBubbleTemplate"
    ]
  }
]

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

string

required

link

string

required

Link associated with the video.

media_job

string | null

required

Media job associated with the video. Default is null.

status

string

required

failed_reason

string | null

required

Reason for failure. Default is null.

is_hidden

boolean

required

video_output

string

required

Generated Video URL

video_thumbnail

string

required

Generated Video Thumbnail URL

credits_used

integer

required

Credits used in this api call

progress

string

required

preview

string

required

Preview URL

previews

object[]

required

List of previews

visual_styles

enum<string>[]

required

AvatarBubbleTemplate - Avatar Bubble
DramaticTemplate - Dramatic
DynamicGreenScreenEffect - Dynamic Green Screen Effect
DynamicProductTemplate - Product
DynamicResponseBubbleTemplate - Response Bubble
EnhancedVanillaTemplate - Dynamic Vanilla
FullScreenTemplate - Full Screen
FullScreenV2Template - Full Screen V2
GreenScreenEffectTemplate - Green Screen Effect
LegoTemplate - Lego
MotionCardsTemplate - Motion Cards
OverCardsTemplate - Over Cards
QuickTransitionTemplate - Quick Transition
ScribbleTemplate - Scribble
SideBySideTemplate - Side by Side
SimpleAvatarOverlayTemplate - Product Presenter
TopBottomTemplate - Top & Bottom
TwitterFrameTemplate - Twitter Frame
VanillaTemplate - Vanilla
VlogTemplate - Vlog
LegoVisualEmotional - Emotional
LegoVisualCutePets - Cute Pets
LegoScriptNegativeHook - Don’t Use This If You Want...
LegoScriptNumberOneHook - The #1 Hack You Need
LegoScriptEverWonderHook - Ever Wonder Why?
LegoScriptSecretHook - Wish I Could Keep This Secret
LegoScriptWhatHappensHook - What Happens If You Try This?
LegoScriptAnyoneElseHook - That One Thing We All Have
LegoScriptAmazedHook - Still Amazed by This
LegoScript2025Hook - Hack 2025 Like This
LegoScriptHateMeHook - They’ll Hate Me for This
LegoScriptResponseBubbleTextOverlay - Response bubble

Available options:

AvatarBubbleTemplate,

DramaticTemplate,

DynamicGreenScreenEffect,

DynamicProductTemplate,

DynamicResponseBubbleTemplate,

EnhancedVanillaTemplate,

FullScreenTemplate,

FullScreenV2Template,

GreenScreenEffectTemplate,

LegoTemplate,

MotionCardsTemplate,

OverCardsTemplate,

QuickTransitionTemplate,

ScribbleTemplate,

SideBySideTemplate,

SimpleAvatarOverlayTemplate,

TopBottomTemplate,

TwitterFrameTemplate,

VanillaTemplate,

VlogTemplate,

LegoVisualEmotional,

LegoVisualCutePets,

LegoScriptNegativeHook,

LegoScriptNumberOneHook,

LegoScriptEverWonderHook,

LegoScriptSecretHook,

LegoScriptWhatHappensHook,

LegoScriptAnyoneElseHook,

LegoScriptAmazedHook,

LegoScript2025Hook,

LegoScriptHateMeHook,

LegoScriptResponseBubbleTextOverlay

name

string | null

Name of the video. Default is null.

Maximum length: 255

target_platform

string

Target platform for the video. Default is 'tiktok'.

Maximum length: 255

target_audience

string | null

Target audience for the video. Default is 'young adults'.

language

enum<string>

Language of the video. Default is 'en'.

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>

Length of the video in seconds. Default is 15.

15 - 15
30 - 30
60 - 60

Available options:

15,

30,

60

aspect_ratio

enum<string>

Aspect ratio of the video. Default is '16x9'.

16x9 - 16x9
1x1 - 1x1
9x16 - 9x16

Available options:

16x9,

1x1,

9x16

script_style

enum<string>

Script style of the video. Default is DiscoveryWriter.

BenefitsV2 - Benefits
BrandStoryV2 - Brand Story
CallToActionV2 - Call To Action
DiscoveryWriter - Discovery
DontWorryWriter - Don't Worry
EmotionalWriter - Emotional
GenzWriter - Gen Z
HowToV2 - How To
LetMeShowYouWriter - Let Me Show You
MotivationalWriter - Motivational
ProblemSolutionV2 - Problem Solution
ProblemSolutionWriter - Problem-Solution
ProductHighlightsV2 - Product Highlights
ProductLifestyleV2 - Product Lifestyle
ResponseBubbleWriter - Response Bubble
SpecialOffersV2 - Special Offers
StoryTimeWriter - Storytime
ThreeReasonsWriter - 3 Reasons Why
TrendingTopicsV2 - Trending Topics
DIY - DIY

Available options:

BenefitsV2,

BrandStoryV2,

CallToActionV2,

DiscoveryWriter,

DontWorryWriter,

EmotionalWriter,

GenzWriter,

HowToV2,

LetMeShowYouWriter,

MotivationalWriter,

ProblemSolutionV2,

ProblemSolutionWriter,

ProductHighlightsV2,

ProductLifestyleV2,

ResponseBubbleWriter,

SpecialOffersV2,

StoryTimeWriter,

ThreeReasonsWriter,

TrendingTopicsV2,

DIY

visual_style

enum<string>

Visual style of the video. Default is AvatarBubbleTemplate.

AvatarBubbleTemplate - Avatar Bubble
DramaticTemplate - Dramatic
DynamicGreenScreenEffect - Dynamic Green Screen Effect
DynamicProductTemplate - Product
DynamicResponseBubbleTemplate - Response Bubble
EnhancedVanillaTemplate - Dynamic Vanilla
FullScreenTemplate - Full Screen
FullScreenV2Template - Full Screen V2
GreenScreenEffectTemplate - Green Screen Effect
LegoTemplate - Lego
MotionCardsTemplate - Motion Cards
OverCardsTemplate - Over Cards
QuickTransitionTemplate - Quick Transition
ScribbleTemplate - Scribble
SideBySideTemplate - Side by Side
SimpleAvatarOverlayTemplate - Product Presenter
TopBottomTemplate - Top & Bottom
TwitterFrameTemplate - Twitter Frame
VanillaTemplate - Vanilla
VlogTemplate - Vlog
LegoVisualEmotional - Emotional
LegoVisualCutePets - Cute Pets
LegoScriptNegativeHook - Don’t Use This If You Want...
LegoScriptNumberOneHook - The #1 Hack You Need
LegoScriptEverWonderHook - Ever Wonder Why?
LegoScriptSecretHook - Wish I Could Keep This Secret
LegoScriptWhatHappensHook - What Happens If You Try This?
LegoScriptAnyoneElseHook - That One Thing We All Have
LegoScriptAmazedHook - Still Amazed by This
LegoScript2025Hook - Hack 2025 Like This
LegoScriptHateMeHook - They’ll Hate Me for This
LegoScriptResponseBubbleTextOverlay - Response bubble

Available options:

AvatarBubbleTemplate,

DramaticTemplate,

DynamicGreenScreenEffect,

DynamicProductTemplate,

DynamicResponseBubbleTemplate,

EnhancedVanillaTemplate,

FullScreenTemplate,

FullScreenV2Template,

GreenScreenEffectTemplate,

LegoTemplate,

MotionCardsTemplate,

OverCardsTemplate,

QuickTransitionTemplate,

ScribbleTemplate,

SideBySideTemplate,

SimpleAvatarOverlayTemplate,

TopBottomTemplate,

TwitterFrameTemplate,

VanillaTemplate,

VlogTemplate,

LegoVisualEmotional,

LegoVisualCutePets,

LegoScriptNegativeHook,

LegoScriptNumberOneHook,

LegoScriptEverWonderHook,

LegoScriptSecretHook,

LegoScriptWhatHappensHook,

LegoScriptAnyoneElseHook,

LegoScriptAmazedHook,

LegoScript2025Hook,

LegoScriptHateMeHook,

LegoScriptResponseBubbleTextOverlay

override_avatar

string | null

Override avatar for the video. Default is null.

Maximum length: 255

override_voice

string | null

Override voice for the video. Default is null.

Maximum length: 255

override_script

string | null

Override script for the video. Default is null.

background_music_url

string | null

Background music URL for the video. Default is null, video will use random music.

Maximum length: 255

background_music_volume

number | null

Volume of the background music, ranging from 0.0 to 1.0. Default is null, video will use default music volume of visual_style.

Required range: 0 <= x <= 1

voiceover_volume

number | null

Volume of the voiceover, ranging from 0.0 to 1.0. Default is null, video will use default voiceover volume of visual_style.

Required range: 0 <= x <= 1

webhook_url

string | null

Webhook URL for status updates. Default is null.

Maximum length: 200

no_background_music

boolean

No background music for the video. Default is false, video with background music.

no_caption

boolean

No caption for the video. Default is false, video with caption.

no_emotion

boolean

No emotion for the video. Default is false, video with emotion.

no_cta

boolean

No call to action for the video. Default is false, video with call to action.

no_stock_broll

boolean

No stock broll for the video. Default is false, video with stock broll.

caption_style

Deprecated, use style in caption_setting instead. Caption style for the video. Default is 'normal-black'.

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 | null

Deprecated, use offset in caption_setting instead. Caption offset x is horizontally relative to the center of the canvas in percentage, range from -0.5 to 0.5. Default is null, video with default caption position of visual_style.

caption_offset_y

string | null

Deprecated, use offset in caption_setting instead. Caption offset y is vertically relative to the center of the canvas in percentage, range from -0.5 to 0.5. Default is null, video with default caption position of visual_style.

caption_setting

object

Caption setting, default null and default caption setting will be used

caption_setting.style

Caption style

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_setting.offset

object

Caption offset

caption_setting.font_family

Font family

Montserrat - Montserrat
Jockey One - JockeyOne
Lilita One - LilitaOne
Mclaren - Mclaren
Corben - Corben
Dela Gothic One - DelaGothicOne
Comfortaa - Comfortaa
Luckiest Guy - LuckiestGuy
Quantico - Quantico
Poppins - Poppins

Available options:

Montserrat,

Jockey One,

Lilita One,

Mclaren,

Corben,

Dela Gothic One,

Comfortaa,

Luckiest Guy,

Quantico,

Poppins

caption_setting.font_size

integer | null

Font size

caption_setting.font_style

Font style

font-bold - BOLD
italic - ITALIC
underline - UNDERLINE

Available options:

font-bold,

italic,

underline

caption_setting.background_color

string | null

Caption background color, hex color with an alpha channel: #RRGGBBAA.

caption_setting.text_color

string | null

Caption text color, hex color with an alpha channel: #RRGGBBAA.

caption_setting.highlight_text_color

string | null

Caption highlight color for the word currently being spoken, hex color with an alpha channel: #RRGGBBAA.

caption_setting.max_width

integer | null

Caption max width in px

caption_setting.line_height

number | null

Caption line height

caption_setting.text_shadow

string | null

Caption text shadow

caption_setting.hidden

boolean

default:false

Hide caption

Get video result Generate Preview video from link

curl --request GET \
  --url https://api.creatify.ai/api/link_to_videos/ \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>'

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "target_platform": "<string>",
    "target_audience": "<string>",
    "language": "ar",
    "video_length": 15,
    "aspect_ratio": "16x9",
    "script_style": "BenefitsV2",
    "visual_style": "AvatarBubbleTemplate",
    "override_avatar": "<string>",
    "override_voice": "<string>",
    "override_script": "<string>",
    "background_music_url": "<string>",
    "background_music_volume": 0.5,
    "voiceover_volume": 0.5,
    "webhook_url": "<string>",
    "link": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "media_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>",
    "failed_reason": "<string>",
    "is_hidden": true,
    "video_output": "<string>",
    "video_thumbnail": "<string>",
    "credits_used": 123,
    "progress": "<string>",
    "no_background_music": true,
    "no_caption": true,
    "no_emotion": true,
    "no_cta": true,
    "no_stock_broll": true,
    "preview": "<string>",
    "previews": [
      {
        "media_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "url": "<string>"
      }
    ],
    "caption_style": "normal-black",
    "caption_offset_x": "<string>",
    "caption_offset_y": "<string>",
    "caption_setting": {
      "style": "normal-black",
      "offset": {
        "x": 0,
        "y": 0.4
      },
      "font_family": "Montserrat",
      "font_size": 123,
      "font_style": "font-bold",
      "background_color": "<string>",
      "text_color": "<string>",
      "highlight_text_color": "<string>",
      "max_width": 123,
      "line_height": 123,
      "text_shadow": "<string>",
      "hidden": false
    },
    "visual_styles": [
      "AvatarBubbleTemplate"
    ]
  }
]

API Documentation

Link to videos

Links

Lipsyncs

Lipsyncs v2

AI Scripts

Text to Speech

AI Shorts

AI Editing

Custom Templates

Avatar

DYOA

Voices

Musics

Workspace

Authorizations

Query Parameters

Response