Getting started
Analytics
Background tracks
Content
Languages
Organization settings
Project voices
Player settings
Player
Playlists
Webhooks
Projects
Roles
RSS Feed
Rules
Summarization Settings
Video Settings
Get player by source ID
Gets player data related to a content item
curl --request GET \
--url https://api.beyondwords.io/v1/projects/{project_id}/player/by_source_id/{id}
{
"language": "en_US",
"content": [
{
"id": "52acb1c0-9681-4138-9d74-1b7234f80922",
"title": "Content title",
"source_id": "example-source-id",
"source_url": "https://example.com/my-article",
"author": "John Smith",
"image_url": "https://example.com/image.jpeg",
"audio": [
{
"id": 123,
"content_type": "audio/mpeg",
"url": "https://example.com/audio.mp3",
"duration": 10000
}
],
"video": [
{
"id": 456,
"content_type": "video/mp4",
"url": "https://example.com/video.mp4",
"duration": 10000
}
],
"segments": [
{
"marker": "title-marker",
"start_time": 3,
"duration": 2997
},
{
"marker": "first-paragraph-marker",
"start_time": 3000,
"duration": 7000
}
],
"ads_enabled": true
}
],
"settings": {
"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"
},
"light_theme": {
"text_color": "#323232",
"background_color": "#FAFAFA",
"icon_color": "#323232"
},
"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
},
"video_settings": {
"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",
"waveform_color": "linear-gradient(to right, red, blue)",
"content_image_enabled": true
},
"playlist": {
"id": 555,
"title": "My playlist",
"type": "manual",
"image_url": "https://example.com/image.jpeg",
"content_limit": 25
},
"ads": [
{
"id": 7,
"type": "custom",
"placement": "pre-roll",
"vast_url": null,
"title": "Ad title",
"click_through_url": "https://example.com/click-through-url",
"media_url": "https://example.com/advert.mp3",
"media": [
{
"id": 100,
"content_type": "audio/mpeg",
"url": "https://example.com/transcoded_advert.mp3",
"duration": 15000
}
],
"theme": null,
"dark_theme": null,
"light_theme": null
}
]
}
Path Parameters
The numeric ID of your project
The source_id of your content item
Query Parameters
The preview token of your content item
Response
Content that has been filtered to published=true and status=processed. See the swagger schema for /v1/content for more information.
Player settings for the project of the first content item. See the swagger schema for /v1/player_settings for more information.
small
, standard
, large
, video
auto
, dark
, light
none
, small
, standard
, large
, video
auto
, left
, center
, right
Video settings for the project of the first content item. See the swagger schema for /v1/video_settings for more information.
top-left
, top-right
Playlist data, if applicable for the endpoint. Endpoint /v1/player/content/{id} returns null. Endpoint /v1/player/playlist/{id} returns data of the playlist. Endpoint /v1/player/playlist returns data of the first playlist (if any). See the swagger schema for /v1/playlist for more information.
Ads that have been filtered to enabled=true and time_range overlaps the current time. See the swagger schema for /v1/ads for more information.
custom
, vast
pre-roll
, mid-roll
, post-roll
auto
, dark
, light
curl --request GET \
--url https://api.beyondwords.io/v1/projects/{project_id}/player/by_source_id/{id}
{
"language": "en_US",
"content": [
{
"id": "52acb1c0-9681-4138-9d74-1b7234f80922",
"title": "Content title",
"source_id": "example-source-id",
"source_url": "https://example.com/my-article",
"author": "John Smith",
"image_url": "https://example.com/image.jpeg",
"audio": [
{
"id": 123,
"content_type": "audio/mpeg",
"url": "https://example.com/audio.mp3",
"duration": 10000
}
],
"video": [
{
"id": 456,
"content_type": "video/mp4",
"url": "https://example.com/video.mp4",
"duration": 10000
}
],
"segments": [
{
"marker": "title-marker",
"start_time": 3,
"duration": 2997
},
{
"marker": "first-paragraph-marker",
"start_time": 3000,
"duration": 7000
}
],
"ads_enabled": true
}
],
"settings": {
"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"
},
"light_theme": {
"text_color": "#323232",
"background_color": "#FAFAFA",
"icon_color": "#323232"
},
"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
},
"video_settings": {
"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",
"waveform_color": "linear-gradient(to right, red, blue)",
"content_image_enabled": true
},
"playlist": {
"id": 555,
"title": "My playlist",
"type": "manual",
"image_url": "https://example.com/image.jpeg",
"content_limit": 25
},
"ads": [
{
"id": 7,
"type": "custom",
"placement": "pre-roll",
"vast_url": null,
"title": "Ad title",
"click_through_url": "https://example.com/click-through-url",
"media_url": "https://example.com/advert.mp3",
"media": [
{
"id": 100,
"content_type": "audio/mpeg",
"url": "https://example.com/transcoded_advert.mp3",
"duration": 15000
}
],
"theme": null,
"dark_theme": null,
"light_theme": null
}
]
}