Skip to main content
GET
/
projects
/
{project_id}
/
player
/
by_playlist_id
/
{id}
Show
curl --request GET \
  --url https://api.beyondwords.io/v1/projects/{project_id}/player/by_playlist_id/{id}
{
  "language": "<string>",
  "content": [
    {
      "id": "<string>",
      "title": "<string>",
      "source_id": "<string>",
      "source_url": "<string>",
      "author": "<string>",
      "image_url": "<string>",
      "audio": [
        {
          "id": 123,
          "content_type": "audio/mpeg",
          "url": "<string>",
          "duration": 123
        }
      ],
      "video": [
        {
          "id": 123,
          "content_type": "video/mp4",
          "url": "<string>",
          "duration": 123
        }
      ],
      "segments": [
        {
          "marker": "<string>",
          "start_time": 123,
          "duration": 123
        }
      ],
      "ads_enabled": true
    }
  ],
  "settings": {
    "enabled": true,
    "player_style": "small",
    "player_title": "<string>",
    "call_to_action": "<string>",
    "image_url": "<string>",
    "theme": "auto",
    "dark_theme": {
      "text_color": "<string>",
      "background_color": "<string>",
      "icon_color": "<string>",
      "highlight_color": "<string>"
    },
    "light_theme": {
      "text_color": "<string>",
      "background_color": "<string>",
      "icon_color": "<string>",
      "highlight_color": "<string>"
    },
    "video_theme": {
      "text_color": "<string>",
      "background_color": "<string>",
      "icon_color": "<string>"
    },
    "title_enabled": true,
    "image_enabled": true,
    "widget_style": "none",
    "widget_position": "auto",
    "segment_playback_enabled": true,
    "segment_highlights_enabled": true,
    "skip_button_style": "<string>",
    "intro": "<string>",
    "outro": "<string>",
    "intro_outro_enabled": true,
    "download_button_enabled": true,
    "logo_icon_enabled": true,
    "analytics_enabled": true,
    "analytics_uuid_enabled": true,
    "analytics_url": "<string>",
    "analytics_custom_url": "<string>",
    "analytics_id": 123,
    "analytics_tag_enabled": true,
    "analytics_tag": "<string>"
  },
  "video_settings": {
    "enabled": true,
    "logo_image_url": "<string>",
    "logo_image_position": "top-left",
    "background_color": "<string>",
    "text_transform": "none",
    "text_background_color": "<string>",
    "text_color": "<string>",
    "text_secondary_color": "<string>",
    "text_highlight_color": "<string>",
    "text_highlight_secondary_color": "<string>",
    "text_highlight_background_color": "<string>",
    "text_shadow": "<string>",
    "text_highlight_shadow": "<string>",
    "text_stroke": "<string>",
    "text_highlight_stroke": "<string>",
    "text_fonts": [
      "<string>"
    ],
    "text_font_size": 123,
    "text_lines": 123,
    "text_words": 123,
    "text_horizontal_align": "start",
    "text_vertical_align": "start",
    "text_animation": "classic",
    "entrance_animation": "none",
    "exit_animation": "none",
    "waveform_color": "<string>",
    "content_image_enabled": true,
    "playback_mode": "cycle",
    "cycle_time": 123
  },
  "playlist": {
    "id": 123,
    "title": "<string>",
    "type": "project",
    "image_url": "<string>",
    "content_limit": 123
  },
  "ads": [
    {
      "id": 123,
      "type": "custom",
      "placement": "pre-roll",
      "vast_url": "<string>",
      "title": "<string>",
      "click_through_url": "<string>",
      "media_url": "<string>",
      "media": [
        {
          "id": 123,
          "content_type": "<string>",
          "url": "<string>",
          "duration": 123
        }
      ],
      "theme": "auto",
      "dark_theme": {
        "text_color": "<string>",
        "background_color": "<string>",
        "icon_color": "<string>",
        "highlight_color": "<string>"
      },
      "light_theme": {
        "text_color": "<string>",
        "background_color": "<string>",
        "icon_color": "<string>",
        "highlight_color": "<string>"
      },
      "video_theme": {
        "text_color": "<string>",
        "background_color": "<string>",
        "icon_color": "<string>"
      }
    }
  ]
}

Headers

​
x-beyondwords-checksum
string

Path Parameters

​
project_id
string
required

The numeric ID of your project

​
id
string
required

The numeric ID of your playlist

Query Parameters

​
summary
boolean
​
preview_page
string

Whether the request originated from the preview page

​
media_format
enum<string>
Available options:
audio,
video

Response

200 - application/json

OK

​
language
string
​
content
object[]

Content that has been filtered to published=true and status=processed. See the swagger schema for /v1/content for more information.

​
settings
object

Player settings for the project of the first content item. See the swagger schema for /v1/player_settings for more information.

​
video_settings
object

Video settings for the project of the first content item. See the swagger schema for /v1/video_settings for more information.

​
playlist
object

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
object[]

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.