PUT
/
projects
/
{project_id}
/
video_settings
curl --request PUT \
  --url https://api.beyondwords.io/v1/projects/{project_id}/video_settings \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "enabled": true,
  "logo_image_url": null,
  "logo_image_position": "top-right",
  "background_color": "white",
  "text_background_color": "rgba(255, 255, 255, 0.88)",
  "text_color": "black",
  "text_highlight_color": "linear-gradient(to right, #933AFB, #FB3A41)",
  "text_fonts": [
    "Inter-Medium.ttf",
    "NotoSansSC-Medium.ttf",
    "NotoSansJP-Medium.ttf"
  ],
  "waveform_color": "linear-gradient(to right, #933AFB, #FB3A41)",
  "content_image_enabled": true,
  "image_extraction_enabled": true,
  "pan_and_zoom_enabled": true,
  "audio_and_waveform_enabled": true,
  "text_captions_enabled": true
}'
{
  "enabled": true,
  "logo_image_url": "https://example.com/logo.png",
  "logo_image_position": "top-right",
  "background_color": "white",
  "text_background_color": "rgba(255, 255, 255, 0.88)",
  "text_color": "black",
  "text_highlight_color": "#0cf",
  "text_fonts": [
    "Inter-Medium.ttf",
    "NotoSansSC-Medium.ttf",
    "NotoSansJP-Medium.ttf"
  ],
  "waveform_color": "linear-gradient(to right, red, blue)",
  "content_image_enabled": true,
  "image_extraction_enabled": true,
  "pan_and_zoom_enabled": true,
  "audio_and_waveform_enabled": true,
  "text_captions_enabled": true
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
project_id
string
required

The numeric ID of your project

Body

application/json
​
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
enum<string>

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

Available options:
top-left,
top-right
​
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, ...)

​
text_fonts
string[]

The ordered list of fonts to use. Characters will be rendered in the first font that supports them. The default fonts are built-in, but you can include remote URLs to custom fonts in .ttf or .otf format.

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

Response

200
application/json
successful
​
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
enum<string>

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

Available options:
top-left,
top-right
​
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, ...)

​
text_fonts
string[]

The ordered list of fonts to use. Characters will be rendered in the first font that supports them. The default fonts are built-in, but you can include remote URLs to custom fonts in .ttf or .otf format.

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