Link to videos
Create video from link
POST
/
api
/
link_to_videos
/
About Request Data Structure of Webhook
When the ‘create video from link’ interface is requested, if the ‘webhook_url’ is passed in the parameters, the program will initiate a POST request to this network address when the task succeeds or fails, with the following content:
{
'id': 'string',
'status': 'string',
’failed_reason’: 'string',
'video_output': 'string',
}
Arguments:
id
(string): The unique identifier of the jobstatus
(string): The status of the job. Possible values arepending
,in_queue
,running
,failed
,done
failed_reason
(string): The reason of the failure if the job failedvideo_output
(string): The URL of the video if the job is done
Authorizations
X-API-ID
string
headerrequiredAPI ID, from your settings page.
X-API-KEY
string
headerrequiredAPI Key, from your settings page.
Body
target_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 BubbleFullScreenTemplate
- Full ScreenFullScreenTemplate2
- Full ScreenGreenScreenEffectTemplate
- Green Screen EffectMotionCardsTemplate
- Motion CardsOverCardsTemplate
- Over CardsQuickTransitionTemplate
- Quick TransitionScribbleTemplate
- ScribbleSideBySideTemplate
- Side by SideTwitterFrameTemplate
- Twitter FrameVanillaTemplate
- VanillaVanillaTemplate2
- Vanilla
Available options:
AvatarBubbleTemplate
, FullScreenTemplate
, FullScreenTemplate2
, GreenScreenEffectTemplate
, MotionCardsTemplate
, OverCardsTemplate
, QuickTransitionTemplate
, ScribbleTemplate
, SideBySideTemplate
, TwitterFrameTemplate
, VanillaTemplate
, VanillaTemplate2
override_avatar
string | null
override_script
string | null
webhook_url
string | null
link
string
requiredResponse
201 - 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 BubbleFullScreenTemplate
- Full ScreenFullScreenTemplate2
- Full ScreenGreenScreenEffectTemplate
- Green Screen EffectMotionCardsTemplate
- Motion CardsOverCardsTemplate
- Over CardsQuickTransitionTemplate
- Quick TransitionScribbleTemplate
- ScribbleSideBySideTemplate
- Side by SideTwitterFrameTemplate
- Twitter FrameVanillaTemplate
- VanillaVanillaTemplate2
- Vanilla
Available options:
AvatarBubbleTemplate
, FullScreenTemplate
, FullScreenTemplate2
, GreenScreenEffectTemplate
, MotionCardsTemplate
, OverCardsTemplate
, QuickTransitionTemplate
, ScribbleTemplate
, SideBySideTemplate
, TwitterFrameTemplate
, VanillaTemplate
, VanillaTemplate2
override_avatar
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
- Done
Available options:
pending
, in_queue
, running
, failed
, done
failed_reason
string | null
requiredvideo_output
string | null
requiredprogress
string
required