Skip to main content
GET
/
api
/
link_to_videos
/
cURL
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": "9x16",
    "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>",
    "outputs": [
      {
        "media_job": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "visual_style": "AvatarBubbleTemplate",
        "aspect_ratio": "9x16",
        "duration": 123,
        "video_output": "<string>",
        "video_thumbnail": "<string>",
        "status": "pending",
        "progress": 123,
        "failed_reason": "<string>"
      }
    ],
    "credits_used": 123,
    "duration": 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",
        "visual_style": "AvatarBubbleTemplate",
        "aspect_ratio": "9x16",
        "url": "<string>",
        "editor_url": "<string>",
        "duration": 123
      }
    ],
    "editor_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
    },
    "model_version": "standard",
    "visual_styles": [
      "AvatarBubbleTemplate"
    ],
    "aspect_ratios": [
      "9x16"
    ]
  }
]

Authorizations

​
X-API-ID
string
header
required
​
X-API-KEY
string
header
required

Query Parameters

​
ids
string
Minimum length: 1

Response

200 - application/json
​
id
string<uuid>
required
​
link
string<uuid>
required
​
media_job
string<uuid> | null
required
​
status
string
required
​
failed_reason
string | null
required
​
is_hidden
boolean
required
​
video_output
string<uri>
required
​
video_thumbnail
string<uri>
required
​
outputs
object[]
required
​
credits_used
integer
required
​
duration
integer
required
​
progress
string
required
​
preview
string<uri>
required
​
previews
object[]
required
​
editor_url
string<uri>
required
​
visual_styles
enum<string>[]
required
Minimum length: 1
​
name
string | null
Maximum length: 255
​
target_platform
string
Maximum length: 255
​
target_audience
string | null
​
language
enum<string>
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>
Available options:
15,
30,
60
​
aspect_ratio
Available options:
9x16,
16x9,
1x1
​
script_style
enum<string>
Available options:
BenefitsV2,
BrandStoryV2,
CallToActionV2,
DiscoveryWriter,
DontWorryWriter,
EmotionalWriter,
GenzWriter,
HowToV2,
LetMeShowYouWriter,
MotivationalWriter,
ProblemSolutionV2,
ProblemSolutionWriter,
ProductHighlightsV2,
ProductLifestyleV2,
ResponseBubbleWriter,
SpecialOffersV2,
StoryTimeWriter,
ThreeReasonsWriter,
TrendingTopicsV2,
NegativeHook,
NumberOneHook,
EverWonderHook,
SecretHook,
WhatHappensHook,
AnyoneElseHook,
AmazedHook,
2025Hook,
HateMeHook,
ResponseBubbleTextOverlay,
HeyAlgorithmHook,
CannotBelieveHook,
FinallyConfidentHook,
PremiumFeelingHook,
FirstTimeFullHook,
LongLineReasonHook,
MissingOutAlertHook,
BetterTodayVersionHook,
BigHappeningHook,
PriceDropRegretHook,
GroupBuyFrustrationHook,
StopAffordExcuseHook,
LifeTooShortDiscountHook,
HugePriceDropRushHook,
PriceCouldGoLowerHook,
StillFullPriceHook,
SecretDiscountShareHook,
VoucherSavingsAlertHook,
CouponDiscoveryRegretHook,
BestDealEverHook,
DIY
​
visual_style
enum<string>
default:AvatarBubbleTemplate
Available options:
AvatarBubbleTemplate,
DramaticTemplate,
DynamicGreenScreenEffect,
DynamicProductTemplate,
DynamicResponseBubbleTemplate,
EnhancedVanillaTemplate,
FeatureHighlightTemplate,
FullScreenTemplate,
FullScreenV2Template,
GreenScreenEffectTemplate,
MotionCardsTemplate,
OverCardsTemplate,
QuickFrameTemplate,
QuickTransitionTemplate,
ScribbleTemplate,
SideBySideTemplate,
SimpleAvatarOverlayTemplate,
TopBottomTemplate,
TwitterFrameTemplate,
VanillaTemplate,
VlogTemplate,
LegoVisualEmotional,
LegoVisualCutePets,
LegoVisualAvatarFocusIntro,
LegoScriptNegativeHook,
LegoScriptNumberOneHook,
LegoScriptEverWonderHook,
LegoScriptSecretHook,
LegoScriptWhatHappensHook,
LegoScriptAnyoneElseHook,
LegoScriptAmazedHook,
LegoScript2025Hook,
LegoScriptHateMeHook,
LegoScriptResponseBubbleTextOverlay,
LegoScriptHeyAlgorithmHook,
LegoScriptCannotBelieveHook,
LegoScriptFinallyConfidentHook,
LegoScriptPremiumFeelingHook,
LegoScriptFirstTimeFullHook,
LegoScriptLongLineReasonHook,
LegoScriptMissingOutAlertHook,
LegoScriptBetterTodayVersionHook,
LegoScriptBigHappeningHook,
LegoScriptPriceDropRegretHook,
LegoScriptGroupBuyFrustrationHook,
LegoScriptStopAffordExcuseHook,
LegoScriptLifeTooShortDiscountHook,
LegoScriptHugePriceDropRushHook,
LegoScriptPriceCouldGoLowerHook,
LegoScriptStillFullPriceHook,
LegoScriptSecretDiscountShareHook,
LegoScriptVoucherSavingsAlertHook,
LegoScriptCouponDiscoveryRegretHook,
LegoScriptBestDealEverHook
​
override_avatar
string | null
Maximum length: 255
​
override_voice
string | null
Maximum length: 255
​
override_script
string | null
​
background_music_url
string<uri> | null
Maximum length: 255
​
background_music_volume
number | null
Required range: 0 <= x <= 1
​
voiceover_volume
number | null
Required range: 0 <= x <= 1
​
webhook_url
string<uri> | null
Maximum length: 200
​
no_background_music
boolean
​
no_caption
boolean
​
no_emotion
boolean
​
no_cta
boolean
​
no_stock_broll
boolean
​
caption_style
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,
comic-shadow,
clean-bold,
soft-pill,
underline-bold,
classic-duo,
hand-script,
button-glow,
emboss-outline,
standard-bold,
outlined-text,
quiet-serif,
editorial-clean,
shout-block,
word-flash,
promo-punch,
light-word,
tagline-bold,
glow-speak,
black-block
​
caption_offset_x
string<decimal> | null
​
caption_offset_y
string<decimal> | null
​
caption_setting
object
​
model_version
enum<string>
Available options:
standard,
aurora_v1,
aurora_v1_fast
​
aspect_ratios
enum<string>[] | null