Link to videos
Get video result
GET
/
api
/
link_to_videos
/
{id}
/
Authorizations
X-API-ID
string
headerrequiredAPI ID, from your settings page.
X-API-KEY
string
headerrequiredAPI Key, from your settings page.
Path Parameters
id
string
requiredA UUID string identifying this Link to Video.
Response
200 - application/json
id
string
requiredtarget_platform
string
target_audience
string
language
enum<string>
ar
- Arabicbg
- Bulgariancs
- Czechda
- Danishde
- Germanel
- Greek, Modernen
- Englishes
- Spanish; Castilianfi
- Finnishfr
- Frenchhi
- Hindihr
- Croatianid
- Indonesianit
- Italianja
- Japaneseko
- Koreanms
- Malaynl
- Dutchpl
- Polishpt
- Portuguesero
- Romanian, Moldavian, Moldovanru
- Russiansk
- Slovaksv
- Swedishta
- Tamiltl
- Tagalogtr
- Turkishuk
- Ukrainianzh
- 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
- 1530
- 3060
- 60
Available options:
15
, 30
, 60
aspect_ratio
enum<string>
16x9
- 16x91x1
- 1x19x16
- 9x16
Available options:
16x9
, 1x1
, 9x16
script_style
enum<string>
DiscoveryWriter
- DiscoveryDontWorryWriter
- Don't WorryEmotionalWriter
- EmotionalGenZWriter
- Gen ZLetMeShowYouWriter
- Let Me Show YouMotivationalWriter
- MotivationalNarrationWriter
- Music StarterProblemSolutionWriter
- Problem-SolutionResponseBubbleWriter
- Response BubbleStoryTimeWriter
- StorytimeThreeResonsWriter
- 3 Reasons WhyDIY
- DIY
Available options:
DiscoveryWriter
, DontWorryWriter
, EmotionalWriter
, GenZWriter
, LetMeShowYouWriter
, MotivationalWriter
, NarrationWriter
, ProblemSolutionWriter
, ResponseBubbleWriter
, StoryTimeWriter
, ThreeResonsWriter
, DIY
visual_style
enum<string>
AvatarBubbleTemplate
- Avatar BubbleDramaticTemplate
- DramaticDynamicProductTemplate
- ProductDynamicResponseBubbleTemplate
- Response BubbleFullScreenTemplate
- Full ScreenGreenScreenEffectTemplate
- Green Screen EffectMotionCardsTemplate
- Motion CardsOverCardsTemplate
- Over CardsQuickTransitionTemplate
- Quick TransitionScribbleTemplate
- ScribbleSideBySideTemplate
- Side by SideTopBottomTemplate
- Top & BottomTwitterFrameTemplate
- Twitter FrameVanillaTemplate
- VanillaVlogTemplate
- Vlog
Available options:
AvatarBubbleTemplate
, DramaticTemplate
, DynamicProductTemplate
, DynamicResponseBubbleTemplate
, FullScreenTemplate
, GreenScreenEffectTemplate
, MotionCardsTemplate
, OverCardsTemplate
, QuickTransitionTemplate
, ScribbleTemplate
, SideBySideTemplate
, TopBottomTemplate
, TwitterFrameTemplate
, VanillaTemplate
, VlogTemplate
override_avatar
string | null
override_voice
string | null
override_script
string | null
webhook_url
string | null
link
string
requiredmedia_job
string | null
requiredstatus
enum<string>
requiredpending
- Pendingin_queue
- In Queuerunning
- Runningfailed
- Faileddone
- Donerejected
- Rejected
Available options:
pending
, in_queue
, running
, failed
, done
, rejected
failed_reason
string | null
requiredvideo_output
string | null
requiredcredits_used
integer | null
requiredprogress
string
requiredno_background_music
boolean
no_caption
boolean
no_emotion
boolean
preview
string | null
requiredcaption_style
enum<string>
normal-black
- NORMAL_BLACKnormal-white
- NORMAL_WHITEnormal-red
- NORMAL_REDnormal-blue
- NORMAL_BLUEneo
- NEObrick
- BRICKfrenzy
- FRENZYverana
- VERANAmustard
- MUSTARDglow
- GLOWmint
- MINTcoolers
- COOLERSbilo
- BILOtoons
- TOONSdeep-blue
- DEEP_BLUEmystique
- MYSTIQUEcaution
- CAUTIONduality
- 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