Update

put

https://api.beyondwords.io/v1/projects/{project_id}/video_settings

Update the video settings for your project

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

project_id

string

required

The numeric ID of your project

Body Params

enabled

boolean

Whether text-to-speech videos should be generated for the project.

logo_image_url

string | null

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

logo_image_position

string

enum

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

Allowed:

background_color

string

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

text_background_color

string

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

text_color

string

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

text_highlight_color

string

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

waveform_color

string

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

content_image_enabled

boolean

Whether to show the content's image_url as the default background image.

image_extraction_enabled

boolean

Whether to extract images by default from HTML content. Alternatively, set the data-beyondwords-image='true' attribute.

pan_and_zoom_enabled

boolean

Whether to automatically pan and zoom images in generated videos.

audio_and_waveform_enabled

boolean

Whether the video should have audio and display an animated waveform.

text_captions_enabled

boolean

Whether the video should have text captions.

Responses

200successful

401Invalid authentication token

422failure