enabledboolean
Whether the player distribution is on or off
player_version'0' | '1'
The player version to use. Possible values are 0 for legacy and 1 for the current
player_style'default' | 'small' | 'standard' | 'large' | 'video'
The style of user interface to show for the player. Possible values are default, small, standard, large, or video
playlist_stylestring
Controls playlist visibility and the maximum visible desktop and mobile rows. For example, auto-5-5 shows playlists automatically with five desktop and mobile rows
playlist_toggle'auto' | 'show' | 'hide'
Controls whether the playlist toggle is shown. Possible values are auto, show, or hide
player_titlestring nullable
The title to show in the large player when there isn't a playlist
call_to_actionstring
The text prompt to show on the player
image_urlstring nullable
An image to show in the player instead of the content's image
theme'auto' | 'dark' | 'light'
The color theme to use for the player. Possible values are auto, dark, or light The 'auto' theme is based on the user's light/dark mode system preference.
title_enabledboolean
Whether to always show the content's title (e.g. instead of the call_to_action)
image_enabledboolean
Whether to show or hide the image in the player
persistent_ad_imageboolean
Whether to show clickable ad images in the player when the ad isn't playing
widget_style'none' | 'small' | 'standard' | 'large' | 'video'
The style of user interface to show for the widget at the bottom of the screen. Possible values are none, small, standard, large, video The widget appears once you scroll past the player in the page.
widget_position'auto' | 'left' | 'center' | 'right'
The side of the screen on which to show the widget. Possible values are auto, left, center, right The 'auto' position places the standard player in the center, otherwise to the right.
segment_playback_enabledboolean
Whether to allow playback by clicking on a segment (i.e. a paragraph) on the page
segment_highlights_enabledboolean
Whether segments should be highlighted in time with content playback
skip_button_stylestring
The style of skip buttons to show in the player. Possible values are segments or seconds You can specify the number of seconds to skip, e.g. seconds-15 or seconds-15-30
intro_urlstring nullable
The URL of an intro audio file to play before all content in the player
outro_urlstring nullable
The URL of an outro audio file to play after all content in the player
intro_outro_enabledboolean
Whether or not the intro and outro should be played. The default is false
download_button_enabledboolean
Whether to show a download button next to each playlist item in the player.
logo_icon_enabledboolean
Whether to show the BeyondWords logo in the player.
analytics_uuid_enabledboolean
analytics_custom_urlstring nullable
Custom analytics server URL
analytics_tag_enabledboolean
analytics_tagstring nullable
updatedstring
Time at which the object was updated (ISO 8601)
word_highlights_enabledboolean
continuous_playback_mode'none' | 'recent'
The continuous playback mode. Possible values are none or recent
outro_playback_mode'after-all' | 'after-each'
The outro playback mode. Possible values are after-all or after-each
radiusinteger
The corner radius of the player, in pixels. The default is 8. Only affects players with the default player_style
disclosure_textstring nullable
The disclosure text to show in the player. Only affects players with the default player_style
disclosure_linkstring nullable
The URL the disclosure text links to. Only affects players with the default player_style
agent_avatar_urlstring nullable
The URL of an avatar image to show for the agent in the player
agent_placeholderstring nullable
The placeholder text to show in the agent input field in the player
agent_shortcutsstring[]
Suggested prompts to show in the agent user interface in the player. The default is an empty array
info_textstring nullable
The informational text to show in the agent user interface in the player
variantsstring[]
The content variants to load in the player. Possible values are article and summary. The default is ["article"]
embed_mode'audio' | 'audio-agent' | 'agent'
The user interface mode of the player. Possible values are audio, audio-agent, or agent. The default is audio
widget_embed_mode'auto' | 'audio' | 'audio-agent' | 'agent'
The user interface mode of the widget. Possible values are auto, audio, audio-agent, or agent. The auto mode follows the embed_mode of the player. The default is auto
agent_voice_enabledboolean
Whether voice conversations with the agent are enabled in the player. The default is true