Authorizations
Path Parameters
The numeric ID of your project
Body
When true, video generation is enabled for this content or project
The logo that should appear in the corner of the video. Defaults to the BeyondWords logo.
2048The position of the logo that appears in the corner of the video.
top-left, top-right The background color of the video when there is no image. Supports CSS colors including linear-gradient(to right, ...)
Text transformation to apply to captions
none, uppercase, lowercase, titlecase The background color to show behind text. Supports CSS colors including linear-gradient(to right, ...)
The foreground color of text. Supports CSS colors including linear-gradient(to right, ...)
Color of the text captions to show on every other scene. (CSS color format)
The foreground color of text whilst the word is being read out. Supports CSS colors including linear-gradient(to right, ...)
Color of highlighted text to show on every other scene. Supports CSS colors including linear-gradient(to right, ...)
Color of the background behind the highlighted text (CSS color format, supports linear-gradient(to right, ...))
100Text shadow of non-highlighted words (CSS format, supports linear-gradient(to right, ...))
Text shadow of highlighted words (CSS format, supports linear-gradient(to right, ...))
Text outline of non-highlighted words (CSS format, supports linear-gradient(to right, ...) and inside/center/outside)
Text outline of highlighted words (CSS format, supports linear-gradient(to right, ...) and inside/center/outside)
A list of fonts to use. Fonts will be prioritized automatically based on glyph coverage for the text. The default fonts are built-in, but you can include remote URLs to custom fonts in .ttf or .otf format.
Font size for text captions (30-90).
30 <= x <= 90The maximum number of lines of text to show at once. Must be between 1 and 5. If not specified, text_lines will default to landscape=4, square=5, portrait=5.
1 <= x <= 5Maximum number of words to show per line
x >= 1The horizontal alignment of text lines, either 'start', 'center', or 'end'. A value of 'start' aligns the text to the left for left-to-right languages, right otherwise. A value of 'end' aligns the text to the right for left-to-right languages, left otherwise.
start, center, end The vertical alignment of text lines, either 'start' (top), 'center', or 'end' (bottom).
start, center, end The text animation to show
classic, reveal, karaoke, pop The color of the audio waveform bars. Supports CSS colors including linear-gradient(to right, ...)
When true, uses the content's featured image as video background
When true, automatically extracts images from HTML content. Alternatively, set the data-beyondwords-image='true' attribute.
When true, applies pan and zoom effects to background images
When true, video includes audio and animated waveform visualization
When true, displays text captions overlaid on the video
The playback mode for images in the video. There are three available options. A value of 'cycle' will cycle through images, potentially repeating them according to cycle_time. A value of 'space-evenly' will space images evenly throughout the video without repeating them. A value of 'follow-article' will show images at the point when they appear in the article. Note that 'follow-article' is not applicable for summaries which have different text.
cycle, space-evenly, follow-article The time in milliseconds to show each image when playback_mode is set to 'cycle'.
1000 <= x <= 60000Response
successful
When true, video generation is enabled for this project
The logo that should appear in the corner of the video. Defaults to the BeyondWords logo.
2048The position of the logo that appears in the corner of the video.
top-left, top-right The background color of the video when there is no image. Supports CSS colors including linear-gradient(to right, ...)
Text transformation to apply to captions
none, uppercase, lowercase, titlecase The background color to show behind text. Supports CSS colors including linear-gradient(to right, ...)
The foreground color of text. Supports CSS colors including linear-gradient(to right, ...)
Color of the text captions to show on every other scene (CSS color format)
The foreground color of text whilst the word is being read out. Supports CSS colors including linear-gradient(to right, ...)
Color of highlighted text to show on every other scene. Supports CSS colors including linear-gradient(to right, ...)
100Color of the background behind the highlighted text (CSS color format, supports linear-gradient(to right, ...))
100Text shadow of non-highlighted words (CSS format, supports linear-gradient(to right, ...))
200Text shadow of highlighted words (CSS format, supports linear-gradient(to right, ...))
200Text outline of non-highlighted words (CSS format, supports linear-gradient(to right, ...) and inside/center/outside)
200Text outline of highlighted words (CSS format, supports linear-gradient(to right, ...) and inside/center/outside)
200A list of fonts to use. Fonts will be prioritized automatically based on glyph coverage for the text. The default fonts are built-in, but you can include remote URLs to custom fonts in .ttf or .otf format.
Font size for text captions (30-90).
30 <= x <= 90The maximum number of lines of text to show at once. Must be between 1 and 5. If not specified, text_lines will default to landscape=4, square=5, portrait=5.
1 <= x <= 5Maximum number of words to show per line
x >= 1The horizontal alignment of text lines, either 'start', 'center', or 'end'. A value of 'start' aligns the text to the left for left-to-right languages, right otherwise. A value of 'end' aligns the text to the right for left-to-right languages, left otherwise.
start, center, end The vertical alignment of text lines, either 'start' (top), 'center', or 'end' (bottom).
start, center, end The text animation to show
classic, reveal, karaoke, pop The color of the audio waveform bars. Supports CSS colors including linear-gradient(to right, ...)
When true, uses the content's featured image as video background
When true, automatically extracts images from HTML content. Alternatively, set the data-beyondwords-image='true' attribute.
When true, applies pan and zoom effects to background images
When true, video includes audio and animated waveform visualization
When true, displays text captions overlaid on the video
The playback mode for images in the video. There are three available options. A value of 'cycle' will cycle through images, potentially repeating them according to cycle_time. A value of 'space-evenly' will space images evenly throughout the video without repeating them. A value of 'follow-article' will show images at the point when they appear in the article. Note that 'follow-article' is not applicable for summaries which have different text.
cycle, space-evenly, follow-article The time in milliseconds to show each image when playback_mode is set to 'cycle'.
1000 <= x <= 60000