Get player settings

GET

projects

{project_id}

player_settings

Show

curl --request GET \
  --url https://api.beyondwords.io/v1/projects/{project_id}/player_settings \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.beyondwords.io/v1/projects/{project_id}/player_settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.beyondwords.io/v1/projects/{project_id}/player_settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.beyondwords.io/v1/projects/{project_id}/player_settings"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.beyondwords.io/v1/projects/{project_id}/player_settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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": "#A4FF0044",
    "word_highlight_color": "#A4FF00"
  },
  "light_theme": {
    "text_color": "#323232",
    "background_color": "#FAFAFA",
    "icon_color": "#323232",
    "highlight_color": "#A4FF0044",
    "word_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,
  "segment_highlights_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,
  "download_button_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",
  "continuous_playback_mode": "none",
  "outro_playback_mode": "after-all",
  "radius": 8,
  "accent_color": "#A4FF00",
  "accent_text_color": "#111",
  "disclosure_text": "Powered by AI",
  "disclosure_link": "https://example.com/disclosure",
  "agent_color": "#123234",
  "agent_avatar_url": "https://example.com/avatar.jpeg",
  "agent_placeholder": "Ask about this article, or anything we've covered…",
  "agent_shortcuts": [
    "What are today's headlines?"
  ],
  "info_text": "AI can make mistakes",
  "variants": [
    "article"
  ],
  "embed_mode": "audio",
  "widget_embed_mode": "auto",
  "agent_voice_enabled": true,
  "updated": "2023-01-01 00:00:00 UTC"
}

{
  "code": 401,
  "message": "Unauthorized"
}

Authorizations

X-Api-Key

string

header

required

Path Parameters

project_id

string

required

The numeric ID of your project

Response

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 default, small, standard, large, or video

Available options:

default,

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

Show child attributes

light_theme

object

The light theme colors

Show child attributes

video_theme

object

The video theme colors

Show child attributes

title_enabled

boolean

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

image_enabled

boolean

deprecated

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

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

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

segment_highlights_enabled

boolean

Whether segments should be highlighted in time with content playback

skip_button_style

string

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

intros_outros

object[]

The URLs of intros and outros audio files

Show child attributes

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

deprecated

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

download_button_enabled

boolean

Whether to show a download button next to each playlist item 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)

word_highlights_enabled

boolean

continuous_playback_mode

enum<string>

The continuous playback mode. Possible values are none or recent

Available options:

none,

recent

outro_playback_mode

enum<string>

The outro playback mode. Possible values are after-all or after-each

Available options:

after-all,

after-each

radius

integer

The corner radius of the player, in pixels. The default is 8. Only affects players with the default player_style

accent_color

string | null

The hexadecimal accent color to use in the player. Only affects players with the default player_style

accent_text_color

string | null

The hexadecimal text color to use on accented elements in the player. Only affects players with the default player_style

disclosure_text

string | null

The disclosure text to show in the player. Only affects players with the default player_style

disclosure_link

string | null

The URL the disclosure text links to. Only affects players with the default player_style

agent_color

string | null

The hexadecimal color to use for the agent user interface in the player

agent_avatar_url

string | null

The URL of an avatar image to show for the agent in the player

agent_placeholder

string | null

The placeholder text to show in the agent input field in the player

agent_shortcuts

string[]

Suggested prompts to show in the agent user interface in the player. The default is an empty array

info_text

string | null

The informational text to show in the agent user interface in the player

variants

enum<string>[]

The content variants to load in the player. Possible values are article and summary. The default is ["article"]

Available options:

article,

summary

embed_mode

enum<string>

The user interface mode of the player. Possible values are audio, audio-agent, or agent. The default is audio

Available options:

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

Available options:

auto,

audio,

audio-agent,

agent

agent_voice_enabled

boolean

Whether voice conversations with the agent are enabled in the player. The default is true

Show

curl --request GET \
  --url https://api.beyondwords.io/v1/projects/{project_id}/player_settings \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.beyondwords.io/v1/projects/{project_id}/player_settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.beyondwords.io/v1/projects/{project_id}/player_settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.beyondwords.io/v1/projects/{project_id}/player_settings"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.beyondwords.io/v1/projects/{project_id}/player_settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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": "#A4FF0044",
    "word_highlight_color": "#A4FF00"
  },
  "light_theme": {
    "text_color": "#323232",
    "background_color": "#FAFAFA",
    "icon_color": "#323232",
    "highlight_color": "#A4FF0044",
    "word_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,
  "segment_highlights_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,
  "download_button_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",
  "continuous_playback_mode": "none",
  "outro_playback_mode": "after-all",
  "radius": 8,
  "accent_color": "#A4FF00",
  "accent_text_color": "#111",
  "disclosure_text": "Powered by AI",
  "disclosure_link": "https://example.com/disclosure",
  "agent_color": "#123234",
  "agent_avatar_url": "https://example.com/avatar.jpeg",
  "agent_placeholder": "Ask about this article, or anything we've covered…",
  "agent_shortcuts": [
    "What are today's headlines?"
  ],
  "info_text": "AI can make mistakes",
  "variants": [
    "article"
  ],
  "embed_mode": "audio",
  "widget_embed_mode": "auto",
  "agent_voice_enabled": true,
  "updated": "2023-01-01 00:00:00 UTC"
}

{
  "code": 401,
  "message": "Unauthorized"
}

Getting started

Content

Extraction

Pronunciation settings

Script settings

Video settings

Background music settings

Voices

Distribution

Integrations

Analytics

Monetization

Organization

Authorizations

Path Parameters

Response