GET
/
projects
/
{project_id}
/
player_settings
curl --request GET \
  --url https://api.beyondwords.io/v1/projects/{project_id}/player_settings \
  --header 'X-Api-Key: <api-key>'
{
  "player_version": "1",
  "player_style": "standard",
  "player_Title": "My Project",
  "call_to_action": "Listen to this article",
  "image_url": "https://example.com/image.jpeg",
  "theme": "auto",
  "dark_theme": {
    "text_color": "#323232",
    "background_color": "#FAFAFA",
    "icon_color": "#323232",
    "highlight_color": "#A4FF00"
  },
  "light_theme": {
    "text_color": "#323232",
    "background_color": "#FAFAFA",
    "icon_color": "#323232",
    "highlight_color": "#A4FF00"
  },
  "video_theme": {
    "text_color": "#323232",
    "background_color": "#FAFAFA",
    "icon_color": "#323232"
  },
  "title_enabled": false,
  "image_enabled": false,
  "persistent_ad_image": false,
  "widget_style": "standard",
  "widget_position": "auto",
  "segment_playback_enabled": true,
  "skip_button_style": "seconds-15-30",
  "intro_url": "https://example.com/intro.mp3",
  "outro_url": "https://example.com/outro.mp3",
  "intro_outro_enabled": false,
  "paywall_type": "none",
  "paywall_url": "https://example.com/members-signup-page",
  "download_button_enabled": false,
  "share_button_enabled": false,
  "voice_icon_enabled": false,
  "logo_icon_enabled": true,
  "analytics_enabled": false,
  "analytics_uuid_enabled": true,
  "analytics_url": "https://metrics.beyondwords.io",
  "analytics_custom_url": "https://custom_metrics.beyondwords.io",
  "analytics_id": 123,
  "analytics_tag_enabled": true,
  "analytics_tag": "UA-123",
  "updated": "2023-01-01 00:00:00 UTC"
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
project_id
string
required

The numeric ID of your project

Response

200
application/json
OK
​
enabled
boolean

Whether the player distribution is on or off

​
player_version
enum<string>

The player version to use. Possible values are 0 for legacy and 1 for the current

Available options:
0,
1
​
player_style
enum<string>

The style of user interface to show for the player. Possible values are small, standard, large, or video

Available options:
small,
standard,
large,
video
​
player_title
string | null

The title to show in the large player when there isn't a playlist

​
call_to_action
string

The text prompt to show on the player

​
image_url
string | null

An image to show in the player instead of the content's image

​
theme
enum<string>

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.

Available options:
auto,
dark,
light
​
dark_theme
object

The dark theme colors

​
light_theme
object

The light theme colors

​
video_theme
object

The video theme colors

​
title_enabled
boolean

Whether to always show the content's title (e.g. instead of the call_to_action)

​
image_enabled
boolean

Whether to show or hide the image in the player

​
persistent_ad_image
boolean

Whether to show clickable ad images in the player when the ad isn't playing

​
widget_style
enum<string>

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.

Available options:
none,
small,
standard,
large,
video
​
widget_position
enum<string>

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.

Available options:
auto,
left,
center,
right
​
segment_playback_enabled
boolean

Whether to allow playback by clicking on a segment (i.e. a paragraph) on the page Support for this depends on adding some markup into the HTML of the page.

​
skip_button_style
string

The style of skip buttons to show in the player. Possible values are auto, segments, seconds or audios You can specify the number of seconds to skip, e.g. seconds-15 or seconds-15-30 The auto style uses audios if there is a playlist and segments otherwise.

​
intros_outros
object[]

The URLs of intros and outros audio files

​
intro_url
string | null

The URL of an intro audio file to play before all content in the player

​
outro_url
string | null

The URL of an outro audio file to play after all content in the player

​
intro_outro_enabled
boolean

Whether or not the intro and outro should be played. The default is false

​
paywall_type
string

The style of paywall to apply to the player. Possible values are none, show, hide or lock You can specify the number of body segments to make listenable, e.g. show-3

​
paywall_url
string | null

The URL to link to when the content is paywalled, e.g. a signup page.

​
download_button_enabled
boolean

Whether to show a download button next to each playlist item in the player.

​
share_button_enabled
boolean

Whether to show a share button in the player.

​
voice_icon_enabled
boolean

Whether to show an icon stating that the voice was AI generated in the player.

​
logo_icon_enabled
boolean

Whether to show the BeyondWords logo in the player.

​
analytics_enabled
boolean

Analytics enabled.

​
analytics_uuid_enabled
boolean

Analytics uuid enabled.

​
analytics_url
string

Analytics server URL

​
analytics_custom_url
string | null

Custom analytics server URL

​
analytics_id
integer

Analytics ID

​
analytics_tag_enabled
boolean

Analytics tag enabled

​
analytics_tag
string | null

Google Analytics tag

​
updated
string

Time at which the object was updated (ISO 8601)

Previous
Update player settings
Next