GET
/
projects
/
{project_id}
/
video_settings
Show
curl --request GET \
  --url https://api.beyondwords.io/v1/projects/{project_id}/video_settings \
  --header 'X-Api-Key: <api-key>'
{
  "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",
    "NotoSansHebrew-Medium.ttf",
    "NotoSansTamil-Medium.ttf"
  ],
  "text_lines": null,
  "text_align": "start",
  "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,
  "playback_mode": "cycle",
  "cycle_time": 15000
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
project_id
string
required

The numeric ID of your project

Response

200
application/json

OK

The response is of type object.