File Endpoint
Generate Video
- API Reference
- Community
- GETGet Fonts List
Fonts Endpoint
File Endpoint
Generate Video
Generates a video based on provided input, words, and configuration, then returns a URL to download the generated file.
POST
/
generate
x-api-key
string
*
x-api-key
Required
string
object
*
input
string
*
input
Required
string
Identifier of the input file for generation.
words
array
*
words
Required
array
Array of words to be included in the generated file.
config
object
*
config
Required
object
colors
object
colors
object
defaultColor
object
defaultColor
object
colors
array
colors
array
spokenColor
object
spokenColor
object
colors
array
colors
array
hilightColor
object
hilightColor
object
colors
array
colors
array
strokeColor
object
strokeColor
object
colors
array
colors
array
backgroundColor
object
backgroundColor
object
colors
array
colors
array
shadowColor
object
shadowColor
object
colors
array
colors
array
modes
object
modes
object
displayMode
enum<string>
displayMode
enum<string>
displayWords
enum<string>
displayWords
enum<string>
spokenMode
enum<string>
spokenMode
enum<string>
effectType
enum<string>
effectType
enum<string>
effectMode
enum<string>
effectMode
enum<string>
displayEmojis
enum<string>
displayEmojis
enum<string>
sizes
object
sizes
object
fontSize
integer
*
fontSize
Required
integer
strokeSize
integer
strokeSize
integer
blurSize
integer
blurSize
integer
emojiSize
integer
emojiSize
integer
backgroundRadius
integer
backgroundRadius
integer
linesCount
integer
linesCount
integer
wordsPerLineCount
integer
wordsPerLineCount
integer
wordHasBackground
boolean
wordHasBackground
boolean
wordHasPunctuation
boolean
wordHasPunctuation
boolean
wordHasShadow
boolean
wordHasShadow
boolean
wordHasCustomShadowColor
boolean
wordHasCustomShadowColor
boolean
emojiAnimated
boolean
emojiAnimated
boolean
capitalizationType
enum<string>
capitalizationType
enum<string>
Authorizations
x-api-key
string
headerrequiredBody
application/json
input
string
requiredIdentifier of the input file for generation.
words
object[]
requiredArray of words to be included in the generated file.
words.start
number
requiredStart time of the word in seconds.
words.end
number
requiredEnd time of the word in seconds.
words.word
string
requiredThe word as transcribed.
words.punctuated_word
string
requiredThe word with punctuation.
config
object
requiredconfig.colors
object
config.colors.defaultColor
object
config.colors.defaultColor.colors
object[]
config.colors.defaultColor.colors.r
integer
config.colors.defaultColor.colors.g
integer
config.colors.defaultColor.colors.b
integer
config.colors.spokenColor
object
config.colors.spokenColor.colors
object[]
config.colors.spokenColor.colors.r
integer
config.colors.spokenColor.colors.g
integer
config.colors.spokenColor.colors.b
integer
config.colors.hilightColor
object
config.colors.hilightColor.colors
object[]
config.colors.hilightColor.colors.r
integer
config.colors.hilightColor.colors.g
integer
config.colors.hilightColor.colors.b
integer
config.colors.strokeColor
object
config.colors.strokeColor.colors
object[]
config.colors.strokeColor.colors.r
integer
config.colors.strokeColor.colors.g
integer
config.colors.strokeColor.colors.b
integer
config.colors.backgroundColor
object
config.colors.backgroundColor.colors
object[]
config.colors.backgroundColor.colors.r
integer
config.colors.backgroundColor.colors.g
integer
config.colors.backgroundColor.colors.b
integer
config.colors.shadowColor
object
config.colors.shadowColor.colors
object[]
config.colors.shadowColor.colors.r
integer
config.colors.shadowColor.colors.g
integer
config.colors.shadowColor.colors.b
integer
config.modes
object
config.modes.displayMode
enum<string>
Available options:
ALL, LINE, WORD config.modes.displayWords
enum<string>
Available options:
PUNCTUATION, FIXED_COUNT config.modes.spokenMode
enum<string>
Available options:
LINE, WORD config.modes.effectType
enum<string>
Available options:
DISABLED, POP, BIG, SMOOTH_POP, FADE, FONT config.modes.effectMode
enum<string>
Available options:
LINE, WORD, GROUP config.modes.displayEmojis
enum<string>
Available options:
WORD, LINE config.sizes
object
config.sizes.fontSize
integer
requiredconfig.sizes.strokeSize
integer
config.sizes.blurSize
integer
config.sizes.emojiSize
integer
config.sizes.backgroundRadius
integer
config.linesCount
integer
config.wordsPerLineCount
integer
config.wordHasBackground
boolean
config.wordHasPunctuation
boolean
config.wordHasShadow
boolean
config.wordHasCustomShadowColor
boolean
config.emojiAnimated
boolean
config.capitalizationType
enum<string>
Available options:
UPPERCASE, LOWERCASE, TITLECASE Response
200 - application/json
download_url
string
Direct URL to download the generated file.