Create content

Authorizations

X-Api-Key

string

header

required

Path Parameters

project_id

string

required

The numeric ID of your project

Query Parameters

segments

enum<string>

The level of detail to show for segments in the response: 'none', 'partial' or 'full'

Available options:

partial,

full

Body

application/json

Auto segment
Manual segment
Audio upload

Create content with auto segment type

type

enum<string>

default:auto_segment

required

The content type. Possible values are auto_segment, manual_segment or audio_upload

Available options:

auto_segment

body

string

required

The content body

title

string

The content title

summary

string

The content summary

title_enabled

boolean

When true, generates audio for the title segment

body_enabled

boolean

When true, generates audio for the body text segments

summary_enabled

boolean

When true, generates audio for the summary content

summary_title_enabled

boolean

When true, includes title text and audio in generated summaries

source_id

string | null

The externally-provided source identifier of the content

source_url

string<uri> | null

The URL that contains the source content

Maximum string length: 2048

author

string | null

The author of the content

image_url

string<uri> | null

The feature image URL of the content

Maximum string length: 2048

metadata

object

The arbitrary metadata associated with content

published

boolean | null

Whether the content will appear in the BeyondWords players and podcast feeds

video_published

boolean | null

Whether the content will appear in the BeyondWords video players and podcast video feeds

publish_date

string<date-time> | null

Time at which the content was published or is scheduled to be published (ISO 8601)

ads_enabled

boolean | null

Whether adverts will play for this content in the BeyondWords players

auto_segment_updates_enabled

boolean | null

Whether the media files will be regenerated when the text content is updated with auto_segment

title_voice_id

integer | null

The id of the voice used to generate the audio of the title text.

Required range: x >= 1

summary_voice_id

integer | null

The id of the voice used to generate the audio of the summary text.

Required range: x >= 1

body_voice_id

integer | null

The id of the voice used to generate the audio of the body text.

Required range: x >= 1

ai_summary_updates_enabled

boolean

Whether the summary segments will be regenerated

language

string | null

The default language of the content, format is ISO 639-1 (with underscore delimiter like en_GB)

Maximum string length: 10

background_track

object

Show child attributes

background_track.enabled

boolean

When true, background music is enabled for this content

background_track.track

object

Show child attributes

background_track.track.id

integer

The track id

summarization_settings

object

Show child attributes

summarization_settings.enabled

boolean

When true, AI-powered summarization is enabled

summarization_settings.model

enum<string>

Available options:

gpt-3.5-turbo,

gpt-4o-mini,

gpt-5-nano,

gpt-5-mini

summarization_settings.prompt

string | null

Custom prompt for AI summarization generation

summarization_settings.temperature

number | null

Controls randomness in AI summarization (0.0 = deterministic, 2.0 = very random)

Required range: 0 <= x <= 2

summarization_settings.limit_token_usage

integer | null

Maximum number of tokens to use for AI summarization

Required range: 1 <= x <= 3000

summarization_settings.template

object

Show child attributes

summarization_settings.template.id

integer

summarization_settings.template.slug

string

The summarization settings template slug

video_settings

object

Show child attributes

video_settings.enabled

boolean

When true, video generation is enabled for this content or project

video_settings.logo_image_url

string<uri> | null

The logo that should appear in the corner of the video. Defaults to the BeyondWords logo.

Maximum string length: 2048

video_settings.logo_image_position

enum<string>

The position of the logo that appears in the corner of the video.

Available options:

top-left,

top-right

video_settings.background_color

string

The background color of the video when there is no image. Supports CSS colors including linear-gradient(to right, ...)

video_settings.text_transform

enum<string>

Text transformation to apply to captions

Available options:

none,

uppercase,

lowercase,

titlecase

video_settings.text_background_color

string

The background color to show behind text. Supports CSS colors including linear-gradient(to right, ...)

video_settings.text_color

string

The foreground color of text. Supports CSS colors including linear-gradient(to right, ...)

video_settings.text_secondary_color

string | null

Color of the text captions to show on every other scene. (CSS color format)

video_settings.text_highlight_color

string | null

The foreground color of text whilst the word is being read out. Supports CSS colors including linear-gradient(to right, ...)

video_settings.text_highlight_secondary_color

string | null

Color of highlighted text to show on every other scene. Supports CSS colors including linear-gradient(to right, ...)

video_settings.text_highlight_background_color

string

Color of the background behind the highlighted text (CSS color format, supports linear-gradient(to right, ...))

Maximum string length: 100

video_settings.text_shadow

string

Text shadow of non-highlighted words (CSS format, supports linear-gradient(to right, ...))

video_settings.text_highlight_shadow

string | null

Text shadow of highlighted words (CSS format, supports linear-gradient(to right, ...))

video_settings.text_stroke

string

Text outline of non-highlighted words (CSS format, supports linear-gradient(to right, ...) and inside/center/outside)

video_settings.text_highlight_stroke

string | null

Text outline of highlighted words (CSS format, supports linear-gradient(to right, ...) and inside/center/outside)

video_settings.text_fonts

string[]

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.

video_settings.text_font_size

integer

Font size for text captions (30-90).

Required range: 30 <= x <= 90

video_settings.text_lines

integer | null

The 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.

Required range: 1 <= x <= 5

video_settings.text_words

integer | null

Maximum number of words to show per line

Required range: x >= 1

video_settings.text_horizontal_align

enum<string>

The 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.

Available options:

start,

center,

end

video_settings.text_vertical_align

enum<string>

The vertical alignment of text lines, either 'start' (top), 'center', or 'end' (bottom).

Available options:

start,

center,

end

video_settings.text_animation

enum<string>

The text animation to show

Available options:

classic,

reveal,

karaoke,

pop

video_settings.entrance_animation

enum<string>

The entrance animation for image and video segments

Available options:

none,

fade,

zoom-in,

zoom-out,

slide-up,

slide-down,

slide-left,

slide-right,

pop

video_settings.exit_animation

enum<string>

The exit animation for image and video segments

Available options:

none,

fade,

zoom-in,

zoom-out,

slide-up,

slide-down,

slide-left,

slide-right,

pop

video_settings.waveform_color

string

The color of the audio waveform bars. Supports CSS colors including linear-gradient(to right, ...)

video_settings.content_image_enabled

boolean

When true, uses the content's featured image as video background

video_settings.image_extraction_enabled

boolean

When true, automatically extracts images from HTML content. Alternatively, set the data-beyondwords-image='true' attribute.

video_settings.pan_and_zoom_enabled

boolean

When true, applies pan and zoom effects to background images

video_settings.audio_and_waveform_enabled

boolean

When true, video includes audio and animated waveform visualization

video_settings.text_captions_enabled

boolean

When true, displays text captions overlaid on the video

video_settings.playback_mode

enum<string>

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.

Available options:

cycle,

space-evenly,

follow-article

video_settings.cycle_time

integer

The time in milliseconds to show each image when playback_mode is set to 'cycle'.

Required range: 1000 <= x <= 60000

video_settings.variants

string[]

video_settings.template

object

Show child attributes

video_settings.template.id

integer

video_settings.template.slug

string

The video settings template slug

feature_image

object

Show child attributes

feature_image.url

string

feature_image.video_settings

object

Show child attributes

feature_image.video_settings.enabled

boolean

feature_image.video_settings.crop_coordinates

object

Show child attributes

feature_image.video_settings.crop_coordinates.16:9

number[]

Maximum array length: 4

feature_image.video_settings.crop_coordinates.9:16

number[]

Maximum array length: 4

feature_video

object

Show child attributes

feature_video.url

string

feature_video.video_settings

object

Show child attributes

feature_video.video_settings.enabled

boolean

feature_video.video_settings.volume

integer

feature_video.video_settings.crop_coordinates

object

Show child attributes

feature_video.video_settings.crop_coordinates.16:9

number[]

Maximum array length: 4

feature_video.video_settings.crop_coordinates.9:16

number[]

Maximum array length: 4

Response

201 - application/json

successful

string | null

Unique identifier for the content. Can be either a UUID or an externally provided source_id

status

enum<string>

The current status of the content processing operation. This value will change as the content is processed.

Available options:

draft,

queued,

processing,

processed,

skipped,

error

type

enum<string>

The content type. Possible values are auto_segment, manual_segment or audio_upload

Available options:

auto_segment,

manual_segment,

audio_upload

title

string | null

The content title

Required string length: 1 - 500

summary

string | null

The content summary

Maximum string length: 2000

body

string | null

The content body

Maximum string length: 100000

title_enabled

boolean

The flag to enable title segments in audio

body_enabled

boolean

The flag to enable body segments in audio

summary_enabled

boolean

The flag to enable summary audio

summary_title_enabled

boolean

The flag to include title text and audio segments in summaries

source_id

string | null

The externally-provided source identifier of the content

source_url

string | null

The URL that contains the source content

author

string | null

The author of the content

image_url

string | null

deprecated

The feature image URL of the content

metadata

object

The arbitrary metadata associated with content

audio

object[]

The array of audio files for the entire content

Show child attributes

audio.id

integer

Unique identifier for the object

audio.variant

enum<string>

The variant type of the audio content

Available options:

article,

summary

audio.orientation

enum<string>

Not applicable for audio content

Available options:

16:9,

9:16

audio.content_type

enum<string> | null

MIME type of the audio file (MP3 or HLS playlist)

Available options:

audio/mpeg,

application/x-mpegURL

audio.url

string<uri> | null

Direct URL to the audio file

audio.duration

integer | null

Duration of the audio file in milliseconds

audio.base64_file

string | null

Base64-encoded content of HLS playlist metadata files

video

object[]

The array of video files for the entire content

Show child attributes

video.id

integer

Unique identifier for the object

video.variant

enum<string>

The variant type of the video content

Available options:

article,

summary

video.orientation

enum<string>

The orientation of the video content

Available options:

16:9,

9:16

video.content_type

enum<string> | null

MIME type of the video file (MP4 or HLS playlist)

Available options:

video/mp4,

application/x-mpegURL

video.url

string | null

Direct URL to the video file

video.duration

integer | null

Duration of the video file in milliseconds

video.base64_file

string | null

The content of the media file encoded as base64. Only present for .m3u8 metadata files

audio_with_intro_outro

object[]

Show child attributes

audio_with_intro_outro.id

integer

Unique identifier for the object

audio_with_intro_outro.variant

enum<string>

The variant type of the audio content

Available options:

article,

summary

audio_with_intro_outro.orientation

enum<string>

Not applicable for audio content

Available options:

16:9,

9:16

audio_with_intro_outro.content_type

enum<string> | null

MIME type of the audio file (MP3 or HLS playlist)

Available options:

audio/mpeg,

application/x-mpegURL

audio_with_intro_outro.url

string<uri> | null

Direct URL to the audio file

audio_with_intro_outro.duration

integer | null

Duration of the audio file in milliseconds

audio_with_intro_outro.base64_file

string | null

Base64-encoded content of HLS playlist metadata files

summarization

object

Show child attributes

summarization.audio

object[]

The array of summary audio files for the entire content

Show child attributes

summarization.audio.id

integer

Unique identifier for the object

summarization.audio.variant

enum<string>

The variant type of the audio content

Available options:

article,

summary

summarization.audio.orientation

enum<string>

Not applicable for audio content

Available options:

16:9,

9:16

summarization.audio.content_type

enum<string> | null

MIME type of the audio file (MP3 or HLS playlist)

Available options:

audio/mpeg,

application/x-mpegURL

summarization.audio.url

string<uri> | null

Direct URL to the audio file

summarization.audio.duration

integer | null

Duration of the audio file in milliseconds

summarization.audio.base64_file

string | null

Base64-encoded content of HLS playlist metadata files

summarization.video

object[]

The array of summary video files for the entire content

Show child attributes

summarization.video.id

integer

Unique identifier for the object

summarization.video.variant

enum<string>

The variant type of the video content

Available options:

article,

summary

summarization.video.orientation

enum<string>

The orientation of the video content

Available options:

16:9,

9:16

summarization.video.content_type

enum<string> | null

MIME type of the video file (MP4 or HLS playlist)

Available options:

video/mp4,

application/x-mpegURL

summarization.video.url

string | null

Direct URL to the video file

summarization.video.duration

integer | null

Duration of the video file in milliseconds

summarization.video.base64_file

string | null

The content of the media file encoded as base64. Only present for .m3u8 metadata files

segments

object[] | null

The array of segments in the content

Show child attributes

segments.id

integer | null

Unique identifier for the segment

segments.marker

string | null

Custom marker for segment identification and playback control

Maximum string length: 255

segments.xpath

string | null

XPath selector for locating this segment in the original HTML document

Maximum string length: 1000

segments.md5

string | null

MD5 hash of the segment text to support per-segment playback

segments.section

enum<string>

Content section type: title for headlines, summary for summaries, or body for main content

Available options:

title,

summary,

body

segments.content_type

enum<string>

Segment content type: text for text-to-speech, audio for pre-recorded audio, or image for visual content in videos

Available options:

text,

audio,

image

segments.text

string | null

Plain text content for text-to-speech conversion. Required when content_type is text

Maximum string length: 1000

segments.audio_url

string<uri> | null

URL to pre-recorded audio file. Required when content_type is audio

Maximum string length: 2048

segments.image_url

string<uri> | null

URL to image file for visual content. Required when content_type is image

Maximum string length: 2048

segments.preprocessing_settings

object

Show child attributes

segments.preprocessing_settings.ai_preprocessing_enabled

boolean

segments.start_time

integer | null

Start time of this segment in the generated audio/video (milliseconds). May differ from calculated duration due to audio processing

Required range: x >= 0

segments.duration

integer | null

Duration of this segment in milliseconds

Required range: x >= 0

segments.created

string<date-time> | null

Time at which the object was created (ISO 8601)

segments.updated

string<date-time> | null

Time at which the object was updated (ISO 8601)

segments.video_settings

object

Show child attributes

segments.video_settings.enabled

boolean

segments.video_settings.volume

integer

segments.video_settings.crop_coordinates

object

Show child attributes

segments.video_settings.crop_coordinates.16:9

number[]

Maximum array length: 4

segments.video_settings.crop_coordinates.9:16

number[]

Maximum array length: 4

published

boolean

Whether the content will appear in the BeyondWords players and podcast feeds

video_published

boolean

Whether the content will appear in the BeyondWords video players and podcast video feeds

publish_date

string | null

Time at which the content was published or is scheduled to be published (ISO 8601)

ads_enabled

boolean

Whether adverts will play for this content in the BeyondWords players

ai_summary_prompt

string | null

The last used AI prompt for summary generation

Maximum string length: 1000

ai_summary_updates_enabled

boolean

Whether the summary segments will be regenerated when the text content is updated

auto_segment_updates_enabled

boolean

Whether the media files will be regenerated when the text content is updated with auto_segment

background_track

object

Show child attributes

background_track.enabled

boolean

background_track.track

object

Show child attributes

background_track.track.id

integer

background_track.track.name

string

background_track.track.custom

boolean

background_track.track.volume

integer

background_track.track.url

string

feature_image

object

Show child attributes

feature_image.url

string

feature_image.video_settings

object

Show child attributes

feature_image.video_settings.enabled

boolean

feature_image.video_settings.crop_coordinates

object

Show child attributes

feature_image.video_settings.crop_coordinates.16:9

number[]

Maximum array length: 4

feature_image.video_settings.crop_coordinates.9:16

number[]

Maximum array length: 4

feature_video

object

Show child attributes

feature_video.url

string

feature_video.video_settings

object

Show child attributes

feature_video.video_settings.enabled

boolean

feature_video.video_settings.volume

integer

feature_video.video_settings.crop_coordinates

object

Show child attributes

feature_video.video_settings.crop_coordinates.16:9

number[]

Maximum array length: 4

feature_video.video_settings.crop_coordinates.9:16

number[]

Maximum array length: 4

summarization_settings

object

Show child attributes

summarization_settings.enabled

boolean

When true, AI-powered summarization is enabled

summarization_settings.prompt

string | null

Custom prompt for AI summarization generation

summarization_settings.model

enum<string> | null

Available options:

gpt-3.5-turbo,

gpt-4o-mini,

gpt-5-nano,

gpt-5-mini

summarization_settings.temperature

number | null

Controls randomness in AI summarization (0.0 = deterministic, 2.0 = very random)

Required range: 0 <= x <= 2

summarization_settings.limit_token_usage

integer | null

Maximum number of tokens to use for AI summarization

Required range: 1 <= x <= 3000

summarization_settings.template

object[] | null

Show child attributes

summarization_settings.template.id

integer

summarization_settings.template.slug

string

Unique identifier for the object

summarization_settings.template.name

string

summarization_settings.template.model

enum<string> | null

Available options:

gpt-3.5-turbo,

gpt-4o-mini,

gpt-5-nano,

gpt-5-mini

summarization_settings.template.prompt

string | null

Custom prompt for AI summarization generation

Maximum string length: 3000

summarization_settings.template.temperature

number | null

Controls randomness in AI summarization (0.0 = deterministic, 2.0 = very random)

Required range: 0 <= x <= 2

summarization_settings.template.limit_token_usage

integer | null

Maximum number of tokens to use for AI summarization

Required range: 1 <= x <= 500

video_settings

object

Show child attributes

video_settings.enabled

boolean

When true, video generation is enabled for this content

video_settings.audio_and_waveform_enabled

boolean

When true, video includes audio and animated waveform visualization

video_settings.background_color

string

Maximum string length: 100

video_settings.content_image_enabled

boolean

When true, uses the content's featured image as video background

video_settings.image_extraction_enabled

boolean

When true, automatically extracts images from HTML content for video backgrounds

video_settings.logo_image_position

enum<string>

Available options:

top-left,

top-right

video_settings.logo_image_url

string<uri>

Maximum string length: 2048

video_settings.pan_and_zoom_enabled

boolean

When true, applies pan and zoom effects to background images

video_settings.text_transform

enum<string>

Text transformation to apply to captions

Available options:

none,

uppercase,

lowercase,

titlecase

video_settings.text_background_color

string

Background color for text captions (CSS color format)

Maximum string length: 100

video_settings.text_captions_enabled

boolean

When true, displays text captions overlaid on the video

video_settings.text_color

string

Color of the text captions (CSS color format)

Maximum string length: 100

video_settings.text_secondary_color

string

Color of the text captions to show on every other scene (CSS color format)

Maximum string length: 100

video_settings.text_highlight_color

string | null

Color of highlighted text during playback (CSS color format)

Maximum string length: 100

video_settings.text_highlight_secondary_color

string | null

Color of highlighted text to show on every other scene (CSS color format)

Maximum string length: 100

video_settings.text_highlight_background_color

string

Color of the background behind the highlighted text (CSS color format, supports linear-gradient(to right, ...))

Maximum string length: 100

video_settings.text_shadow

string

Text shadow of non-highlighted words (CSS format, supports linear-gradient(to right, ...))

Maximum string length: 200

video_settings.text_highlight_shadow

string | null

Text shadow of highlighted words (CSS format, supports linear-gradient(to right, ...))

Maximum string length: 200

video_settings.text_stroke

string

Text outline of non-highlighted words (CSS format, supports linear-gradient(to right, ...) and inside/center/outside)

Maximum string length: 200

video_settings.text_highlight_stroke

string | null

Text outline of highlighted words (CSS format, supports linear-gradient(to right, ...) and inside/center/outside)

Maximum string length: 200

video_settings.text_fonts

string[]

List of font families to use for text rendering (prioritized by glyph coverage)

Maximum array length: 10

Maximum string length: 255

video_settings.text_font_size

integer

Font size for text captions (30-90)

Required range: 30 <= x <= 90

video_settings.text_lines

integer | null

Maximum number of text lines to display simultaneously (1-5)

Required range: 1 <= x <= 5

video_settings.text_words

integer | null

Maximum number of words to show per line

Required range: x >= 1

video_settings.text_horizontal_align

enum<string>

Available options:

start,

center,

end

video_settings.text_vertical_align

enum<string>

The vertical alignment of text lines, either 'start' (top), 'center', or 'end' (bottom).

Available options:

start,

center,

end

video_settings.text_animation

enum<string>

The text animation to show

Available options:

classic,

reveal,

karaoke,

pop

video_settings.entrance_animation

enum<string>

The image entrance animation to show

Available options:

none,

fade,

zoom-in,

zoom-out,

slide-up,

slide-down,

slide-left,

slide-right,

pop

video_settings.exit_animation

enum<string>

The image exit animation to show

Available options:

none,

fade,

zoom-in,

zoom-out,

slide-up,

slide-down,

slide-left,

slide-right,

pop

video_settings.waveform_color

string

Color of the audio waveform visualization (CSS color format)

Maximum string length: 100

video_settings.playback_mode

enum<string>

How images are displayed: cycle (repeat), space-evenly (distribute), or follow-article (match text position)

Available options:

cycle,

space-evenly,

follow-article

video_settings.cycle_time

integer

Duration to show each image when playback_mode is 'cycle' (milliseconds, 1-60 seconds)

Required range: 1000 <= x <= 60000

video_settings.variants

string[]

video_settings.template

object[] | null

Show child attributes

video_settings.template.id

integer

video_settings.template.slug

string

Unique identifier for the object

video_settings.template.name

string

video_settings.template.logo_image_url

string<uri> | null

The logo that should appear in the corner of the video. Defaults to the BeyondWords logo.

Maximum string length: 2048

video_settings.template.logo_image_position

enum<string>

The position of the logo that appears in the corner of the video.

Available options:

top-left,

top-right

video_settings.template.background_color

string

The background color of the video when there is no image. Supports CSS colors including linear-gradient(to right, ...)

video_settings.template.text_transform

enum<string>

Text transformation to apply to captions

Available options:

none,

uppercase,

lowercase,

titlecase

video_settings.template.text_background_color

string

The background color to show behind text. Supports CSS colors including linear-gradient(to right, ...)

video_settings.template.text_color

string

The foreground color of text. Supports CSS colors including linear-gradient(to right, ...)

video_settings.template.text_secondary_color

string | null

Color of the text captions to show on every other scene (CSS color format)

video_settings.template.text_highlight_color

string | null

The foreground color of text whilst the word is being read out. Supports CSS colors including linear-gradient(to right, ...)

video_settings.template.text_highlight_secondary_color

string | null

Color of highlighted text to show on every other scene. Supports CSS colors including linear-gradient(to right, ...)

Maximum string length: 100

video_settings.template.text_highlight_background_color

string

Color of the background behind the highlighted text (CSS color format, supports linear-gradient(to right, ...))

Maximum string length: 100

video_settings.template.text_shadow

string

Text shadow of non-highlighted words (CSS format, supports linear-gradient(to right, ...))

Maximum string length: 200

video_settings.template.text_highlight_shadow

string | null

Text shadow of highlighted words (CSS format, supports linear-gradient(to right, ...))

Maximum string length: 200

video_settings.template.text_stroke

string

Text outline of non-highlighted words (CSS format, supports linear-gradient(to right, ...) and inside/center/outside)

Maximum string length: 200

video_settings.template.text_highlight_stroke

string | null

Text outline of highlighted words (CSS format, supports linear-gradient(to right, ...) and inside/center/outside)

Maximum string length: 200

video_settings.template.text_fonts

string[]

video_settings.template.text_font_size

integer

Font size for text captions (30-90).

Required range: 30 <= x <= 90

video_settings.template.text_lines

integer | null

The 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.

Required range: 1 <= x <= 5

video_settings.template.text_words

integer | null

Maximum number of words to show per line

Required range: x >= 1

video_settings.template.text_horizontal_align

enum<string>

Available options:

start,

center,

end

video_settings.template.text_vertical_align

enum<string>

The vertical alignment of text lines, either 'start' (top), 'center', or 'end' (bottom).

Available options:

start,

center,

end

video_settings.template.text_animation

enum<string>

The text animation to show

Available options:

classic,

reveal,

karaoke,

pop

video_settings.template.entrance_animation

enum<string>

The entrance animation for image and video segments

Available options:

none,

fade,

zoom-in,

zoom-out,

slide-up,

slide-down,

slide-left,

slide-right,

pop

video_settings.template.exit_animation

enum<string>

The exit animation for image and video segments

Available options:

none,

fade,

zoom-in,

zoom-out,

slide-up,

slide-down,

slide-left,

slide-right,

pop

video_settings.template.waveform_color

string

The color of the audio waveform bars. Supports CSS colors including linear-gradient(to right, ...)

video_settings.template.content_image_enabled

boolean

When true, uses the content's featured image as video background

video_settings.template.image_extraction_enabled

boolean

When true, automatically extracts images from HTML content. Alternatively, set the data-beyondwords-image='true' attribute.

video_settings.template.pan_and_zoom_enabled

boolean

When true, applies pan and zoom effects to background images

video_settings.template.audio_and_waveform_enabled

boolean

When true, video includes audio and animated waveform visualization

video_settings.template.text_captions_enabled

boolean

When true, displays text captions overlaid on the video

video_settings.template.playback_mode

enum<string>

Available options:

cycle,

space-evenly,

follow-article

video_settings.template.cycle_time

integer

The time in milliseconds to show each image when playback_mode is set to 'cycle'.

Required range: 1000 <= x <= 60000

video_settings.template.template

array

preprocessing_settings

object

Show child attributes

preprocessing_settings.ai_preprocessing_enabled

boolean

When true, AI preprocessing is applied to improve text normalization quality

language

string | null

The default language of the content

created

string<date-time>

Time at which the object was created (ISO 8601)

updated

string<date-time>

Time at which the object was updated (ISO 8601)

Getting started

Content

Distribution

Analytics

Monetization

Organization

Authorizations

Path Parameters

Query Parameters

Body

Response