View, create, update and delete Vidyard players.

Thumbnails: To get the thumbnail image url of a player simply sub in the player uuid into this url: play.vidyard.com/PLAYER_UUID.jpg

Supported Formats

json

POST https://api.vidyard.com/dashboard/v1/players
Create a new player

Create a new player that can contain video objects

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Content-Type: application/json
{
  "name": "My Player",
  "description": "The besterest videos",
  "default_hd": true,
  "viral_sharing": true,
  "viral_sharing_message": "Check out this awesome video!",
  "height": 360,
  "width": 640,
  "color": "A7A7A7",
  "splash_screen_fade": true,
  "on_complete": "loop",
  "sharing_page": true,
  "sharing_page_comments": true,
  "whitelisted_embed_domain": "*.example.com,example2.com",
  "authorized_by": "platform"
}

RESPONSE
201 (Created)
{
  "id": 1111,
  "uuid": "eQSsPVXinqGoesujP2Vteg",
  "name": "My Player",
  "description": "The besterest videos",
  "play_button": true,
  "autoplay": false,
  "hd_button": true,
  "default_hd": true,
  "embed_button": true,
  "viral_sharing": true,
  "viral_sharing_message": "Check out this awesome video!",
  "custom_sharing_link": null,
  "height": 360,
  "width": 640,
  "color": "A7A7A7",
  "playlist_color": "222222",
  "splash_screen_fade": true,
  "mute_onload": false,
  "playlist_always_open": false,
  "audio_player_visuals": "visualization",
  "on_complete": "loop",
  "redirect_url": null,
  "redirect_whole_page": false,
  "sharing_page": true,
  "sharing_page_comments": true,
  "release_date": 0,
  "whitelisted_embed_domain": "*.example.com,example2.com",
  "authorized_by": "platform",
  "hidden_controls": false,
  "up_next": false,
  "disable_legacy": false,
  "chapters_attributes": [],
  "created_at": 1390585689,
  "updated_at": 1390585689,
  "length_in_seconds": 0,
  "show_playback_speed": false
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

name
optional

Name of the player

Validations:

  • Must be a String

description
optional

Description of the player

Validations:

  • Must be a String

play_button
optional

Display the play button on the thumbnail

Validations:

  • Parameter has to be Boolean.

autoplay
optional

Force the player to start playing when the page loads

Validations:

  • Parameter has to be Boolean.

first_frame
optional

Causes the player to begin playing as soon as it has loaded and then immediately pause
Default: player setting

Validations:

  • Parameter has to be Boolean.

hd_button
optional

Display the HD button on the player controls allowing viewers to toggle the quality of the videos

Validations:

  • Parameter has to be Boolean.

default_hd
optional

Playback automatically set to the highest quality

Validations:

  • Parameter has to be Boolean.

embed_button
optional

Display embed button on player

Validations:

  • Parameter has to be Boolean.

viral_sharing
optional

Adds a share button to your player allowing your viewers to share your videos on social networks and email

Validations:

  • Parameter has to be Boolean.

viral_sharing_message
optional

The message used when viral sharing button is clicked

Validations:

  • Must be a String

custom_sharing_link
optional

The link that will be shared when viral sharing button is clicked
Default: Users will share the page where the player is embedded

Validations:

  • Must be a String

height
optional

Height of the player

Validations:

  • Parameter has to be Integer.

width
optional

Width of the player

Validations:

  • Parameter has to be Integer.

color
optional

Color of the player (Hex)
Eg. “FFFFFF”, “000000”, “55B020” etc.

Validations:

  • Must be a String

playlist_color
optional

Color of the playlist (Hex)
Eg. “FFFFFF”, “000000”, “55B020” etc.

Validations:

  • Must be a String

splash_screen_fade
optional

The player gets highlighted when a viewer’s mouse hovers over it

Validations:

  • Parameter has to be Boolean.

mute_onload
optional

The videos will default to mute with a text overlay prompting the viewer to click for sound

Validations:

  • Parameter has to be Boolean.

playlist_always_open
optional

The playlist is always shown on the side of the player
Adds 319 pixels to the width of the player

Validations:

  • Parameter has to be Boolean.

on_complete
optional , nil allowed

What would you like to happen when all videos have finished playing?
“splash_screen”: (Default) Shows the thumbnail again
“loop”: Loop the playback
“redirect_url”: redirect to the url you set in “redirect_url”

Validations:

  • Must be one of: splash_screen, loop, redirect_url, final_frame, .

redirect_url
optional

URL to redirect the player iframe to when videos have finished playing
Will only redirect if “on_complete” is set to “redirect_url”

Validations:

  • Must be a String

redirect_whole_page
optional

Redirects the entire page if “on_complete” is set to “redirect_url”

Validations:

  • Parameter has to be Boolean.

sharing_page
optional

Enable the sharing page for the player

Validations:

  • Parameter has to be Boolean.

sharing_page_comments
optional

Allow viewers to comment on the sharing page

Validations:

  • Parameter has to be Boolean.

release_date
optional

Timestamp (Unix Time)

Validations:

  • Parameter has to be TimeStamp.

whitelisted_embed_domain
optional

Restrict this player to be embedded only on specific domains
We will automatically match www.example.com, example.com variations and http, https variations.
Any subdomains will be matched if you enter *.example.com

Validations:

  • Must be a String

authorized_by
optional

Restrict this player to a specific platform such as Hubs or Salesforce Chatter

Validations:

  • Must be one of: platform, .

hidden_controls
optional

Disable playback controls

Validations:

  • Parameter has to be Boolean.

up_next
optional

Enable Up Next feature

Validations:

  • Parameter has to be Boolean.

disable_live_dvr
optional

Disable live stream DVR

Validations:

  • Parameter has to be Boolean.

disable_legacy
optional

Disable legacy mode

Validations:

  • Parameter has to be Boolean.

audio_player_visuals
optional

Change what is displayed during playback of an audio chapter

Validations:

  • Must be one of: splash screen, visualization, none.

chapters_attributes
optional

Advanced feature: Used for embedded chapter resource creation
See an example of how to use nested resources in the getting started guide

Validations:

  • Must be an array of any type


GET https://api.vidyard.com/dashboard/v1/players/:id
Get a player

Get a player

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json

RESPONSE
200 (OK)
{
  "id": 1111,
  "uuid": "eQSsPVXinqGoesujP2Vteg",
  "name": "My Player",
  "description": "The besterest videos",
  "play_button": true,
  "autoplay": false,
  "hd_button": true,
  "default_hd": true,
  "embed_button": true,
  "viral_sharing": true,
  "viral_sharing_message": "Check out this awesome video!",
  "custom_sharing_link": null,
  "height": 360,
  "width": 640,
  "color": "A7A7A7",
  "playlist_color": "222222",
  "splash_screen_fade": true,
  "mute_onload": false,
  "playlist_always_open": false,
  "audio_player_visuals": "visualization",
  "on_complete": "splash_screen",
  "redirect_url": null,
  "redirect_whole_page": false,
  "sharing_page": true,
  "sharing_page_comments": true,
  "disable_default_events": false,
  "release_date": 0,
  "whitelisted_embed_domain": "http://*.example.com",
  "authorized_by": "",
  "hidden_controls": false,
  "up_next": false,
  "disable_legacy": false,
  "chapters_attributes":[{
    "position":0,
    "player_id":50,
    "video_id":63,
    "video_attributes":{
      "name":"Falcon Punch",
      "upload_url":null,
      "description":"A description",
      "sync":true,
      "audio_gain":0,
      "webhook_url":null,
      "tags_attributes":[],
      "hosting_provider":"youtube",
      "id":63,
      "status":null,
      "error_message":null,
      "created_at":1374178204,
      "updated_at":1374178204
    },
    "id":37,
    "created_at":1374178204,
    "updated_at":1374178204
  }],
  "created_at": 1390585689,
  "updated_at": 1390585689,
  "length_in_seconds": 0,
  "show_playback_speed": false
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

id
required

Validations:

  • Parameter has to be Integer.


GET https://api.vidyard.com/dashboard/v1/players/uuid=:uuid
Get a player by UUID

Also see "GET Player" for examples.

Get a player by UUID

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

uuid
required

Validations:

  • Must be a String

custom_identifier
optional

Filters the results by custom identifier.
If omitted, only results without a custom identifier will be returned.

Validations:

  • Must be a String


DELETE https://api.vidyard.com/dashboard/v1/players/:id
Delete a player

Delete a player

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

id
required

Validations:

  • Parameter has to be Integer.


GET https://api.vidyard.com/dashboard/v1/players
Get a list of players

Get a list of players. Note that if ‘per_page’ or ‘page’ are used this end point returns a different format. It is recommended to always use ‘per_page’.

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

// USING PER_PAGE OR PAGE
REQUEST
Accept: application/json

RESPONSE
200 (OK)
{
  "players": [
    {
      "id": 1111,
      "uuid": "eQSsPVXinqGoesujP2Vteg",
      "name": "My Player",
      ...
    },
      "id": 1156,
      "uuid": "YBQpV0CPF5ht1UGj0qPHQQ",
      "name": "My Player",
      ...
    }
  ],
  "summary": {
    "page": 1,
    "per_page": 2,
    "count": 4
  }
}

// NOT USING PER_PAGE OR PAGE
REQUEST
Accept: application/json

RESPONSE
200 (OK)
[
  {
    "id": 1111,
    "uuid": "eQSsPVXinqGoesujP2Vteg",
    "name": "My Player",
    ...
  },
    "id": 1156,
    "uuid": "YBQpV0CPF5ht1UGj0qPHQQ",
    "name": "My Player",
    ...
  }
]

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

per_page
optional

The number of items to show per page
Maximum: 200

Validations:

  • Parameter has to be Integer.

page
optional

The page number to include in the response
Only applies when per_page used
Default: 1

Validations:

  • Parameter has to be Integer.

order_by
optional

Only works if ‘per_page’ or ‘page’ parameters are also set.
The attribute to order the list by
Value: Must be one of: name, created_at, updated_at

Validations:

  • Must be one of: name, created_at, updated_at.

direction
optional

Only works if ‘per_page’ or ‘page’ parameters are also set.
When the direction to order the list
Only applies when order_by used
Default: asc
Value: Must be one of: asc, desc

Validations:

  • Must be one of: asc, desc.

query
optional

Only works if ‘per_page’ or ‘page’ parameters are also set.
A string used to search for a set a players by player / video name as well as all associated tags

Validations:

  • Must be a String

include_subgroups
optional

Only works if ‘per_page’ or ‘page’ parameters are also set.
Include players from sub-groups
Default: false

Validations:

  • Must be one of: true, false, 1, 0.


POST https://api.vidyard.com/dashboard/v1/categories/:id/players
Add players to a category

Add players to a category

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
409 Conflict: Conflict with the current state of the resource

Examples

REQUEST
Content-Type: application/json
[
  145643,
  125222,
  234100
]

RESPONSE
200 (OK)
{
  "players": [
    {
      "id": 1111,
      "uuid": "eQSsPVXinqGoesujP2Vteg",
      "name": "My Player",
      ...
    },
      "id": 1156,
      "uuid": "YBQpV0CPF5ht1UGj0qPHQQ",
      "name": "My Player",
      ...
    }
  ],
  "summary": {
    "page": 1,
    "per_page": 2,
    "count": 4
  }
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String


GET https://api.vidyard.com/dashboard/v1/categories/:id/players
Get the list of players for a category

Get the list of players for a category

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json

RESPONSE
200 (OK)
{
  "players": [
    {
      "id": 1111,
      "uuid": "eQSsPVXinqGoesujP2Vteg",
      "name": "My Player",
      ...
    },
      "id": 1156,
      "uuid": "YBQpV0CPF5ht1UGj0qPHQQ",
      "name": "My Player",
      ...
    }
  ],
  "summary": {
    "page": 1,
    "per_page": 2,
    "count": 4
  }
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

per_page
optional

The number of items to show per page
Maximum: 200

Validations:

  • Parameter has to be Integer.

page
optional

The page number to include in the response
Only applies when per_page used
Default: 1

Validations:

  • Parameter has to be Integer.


GET https://api.vidyard.com/dashboard/v1/players/advanced_search
Search for players based on player properties


PATCH https://api.vidyard.com/dashboard/v1/players/:id
Update a player

Update a player

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Content-Type: application/json
{
  "play_button": false,
  "autoplay": true,
  "mute_onload": true,
  "embed_button": false,
  "whitelisted_embed_domain": "*.example.com"
}

RESPONSE
200 (OK)
{
  "id": 1111,
  "uuid": "eQSsPVXinqGoesujP2Vteg",
  "name": "My Player",
  "description": "The besterest videos",
  "play_button": false,
  "autoplay": true,
  "hd_button": true,
  "default_hd": true,
  "embed_button": false,
  "viral_sharing": true,
  "viral_sharing_message": "Check out this awesome video!",
  "custom_sharing_link": null,
  "height": 360,
  "width": 640,
  "color": "A7A7A7",
  "playlist_color": "222222",
  "splash_screen_fade": true,
  "mute_onload": true,
  "playlist_always_open": false,
  "audio_player_visuals": "visualization",
  "on_complete": "loop",
  "redirect_url": null,
  "redirect_whole_page": false,
  "sharing_page": true,
  "sharing_page_comments": true,
  "release_date": 0,
  "whitelisted_embed_domain": "*.example.com",
  "chapters_attributes":[{
    "position":0,
    "player_id":50,
    "video_id":63,
    "video_attributes":{
      "name":"Falcon Punch",
      "upload_url":null,
      "description":"A description",
      "sync":true,
      "audio_gain":0,
      "webhook_url":null,
      "tags_attributes":[],
      "hosting_provider":"youtube",
      "id":63,
      "status":null,
      "error_message":null,
      "created_at":1374178204,
      "updated_at":1374178204
    },
    "id":37,
    "created_at":1374178204,
    "updated_at":1374178204
  }],
  "created_at": 1390585689,
  "updated_at": 1390585689,
  "length_in_seconds": 0,
  "show_playback_speed": false
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

id
required

Validations:

  • Parameter has to be Integer.

name
optional

Name of the player

Validations:

  • Must be a String

description
optional

Description of the player

Validations:

  • Must be a String

play_button
optional

Display the play button on the thumbnail

Validations:

  • Parameter has to be Boolean.

autoplay
optional

Force the player to start playing when the page loads

Validations:

  • Parameter has to be Boolean.

first_frame
optional

Causes the player to begin playing as soon as it has loaded and then immediately pause
Default: player setting

Validations:

  • Parameter has to be Boolean.

hd_button
optional

Display the HD button on the player controls allowing viewers to toggle the quality of the videos

Validations:

  • Parameter has to be Boolean.

default_hd
optional

Playback automatically set to the highest quality

Validations:

  • Parameter has to be Boolean.

embed_button
optional

Display embed button on player

Validations:

  • Parameter has to be Boolean.

viral_sharing
optional

Adds a share button to your player allowing your viewers to share your videos on social networks and email

Validations:

  • Parameter has to be Boolean.

viral_sharing_message
optional

The message used when viral sharing button is clicked

Validations:

  • Must be a String

custom_sharing_link
optional

The link that will be shared when viral sharing button is clicked
Default: Users will share the page where the player is embedded

Validations:

  • Must be a String

height
optional

Height of the player

Validations:

  • Parameter has to be Integer.

width
optional

Width of the player

Validations:

  • Parameter has to be Integer.

color
optional

Color of the player (Hex)
Eg. “FFFFFF”, “000000”, “55B020” etc.

Validations:

  • Must be a String

playlist_color
optional

Color of the playlist (Hex)
Eg. “FFFFFF”, “000000”, “55B020” etc.

Validations:

  • Must be a String

splash_screen_fade
optional

The player gets highlighted when a viewer’s mouse hovers over it

Validations:

  • Parameter has to be Boolean.

mute_onload
optional

The videos will default to mute with a text overlay prompting the viewer to click for sound

Validations:

  • Parameter has to be Boolean.

playlist_always_open
optional

The playlist is always shown on the side of the player
Adds 319 pixels to the width of the player

Validations:

  • Parameter has to be Boolean.

on_complete
optional , nil allowed

What would you like to happen when all videos have finished playing?
“splash_screen”: (Default) Shows the thumbnail again
“loop”: Loop the playback
“redirect_url”: redirect to the url you set in “redirect_url”

Validations:

  • Must be one of: splash_screen, loop, redirect_url, final_frame, .

redirect_url
optional

URL to redirect the player iframe to when videos have finished playing
Will only redirect if “on_complete” is set to “redirect_url”

Validations:

  • Must be a String

redirect_whole_page
optional

Redirects the entire page if “on_complete” is set to “redirect_url”

Validations:

  • Parameter has to be Boolean.

sharing_page
optional

Enable the sharing page for the player

Validations:

  • Parameter has to be Boolean.

sharing_page_comments
optional

Allow viewers to comment on the sharing page

Validations:

  • Parameter has to be Boolean.

release_date
optional

Timestamp (Unix Time)

Validations:

  • Parameter has to be TimeStamp.

whitelisted_embed_domain
optional

Restrict this player to be embedded only on specific domains
We will automatically match www.example.com, example.com variations and http, https variations.
Any subdomains will be matched if you enter *.example.com

Validations:

  • Must be a String

authorized_by
optional

Restrict this player to a specific platform such as Hubs or Salesforce Chatter

Validations:

  • Must be one of: platform, .

hidden_controls
optional

Disable playback controls

Validations:

  • Parameter has to be Boolean.

up_next
optional

Enable Up Next feature

Validations:

  • Parameter has to be Boolean.

disable_live_dvr
optional

Disable live stream DVR

Validations:

  • Parameter has to be Boolean.

disable_legacy
optional

Disable legacy mode

Validations:

  • Parameter has to be Boolean.

audio_player_visuals
optional

Change what is displayed during playback of an audio chapter

Validations:

  • Must be one of: splash screen, visualization, none.


POST https://api.vidyard.com/dashboard/v1/players/:id/access_codes
Create an Access Code for Player

Create an Access Code for Player

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Content-Type: application/json
{
  "max_uses": 1
}

RESPONSE
201 (Created)
{
  "value": "mI2y0ez1",
  "expiry_date": 0,
  "max_uses": 1,
  "creation_method": "access_request",
  "id": 11,
  "created_at": 1431026485,
  "updated_at": 1431026485,
  "player_id": 39
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

max_uses
optional

Set a maximum use limit for the access code
Default: 1

Validations:

  • Parameter has to be Integer.

value
optional

The access code value

Validations:

  • Must be a String

expiry_date
optional

Set expiry date for the access code

Validations:

  • Parameter has to be DateTime.


GET https://api.vidyard.com/dashboard/v1/players/:id/embed_codes
Get a player's embed codes

Get a player’s embed codes. Any parameter not specified will default to the settings chosen for the player.

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json

RESPONSE
200 (OK)
{
  "inline": "<script type=\"text/javascript\" id=\"vidyard_embed_code_w1rHLYXjgE0qq7i9PW6HLA\" src=\"//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.js?v=3.0&type=inline\"></script>",

  "light_box": "<script type=\"text/javascript\" id=\"vidyard_embed_code_w1rHLYXjgE0qq7i9PW6HLA\" src=\"//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.js?v=3.0&type=lightbox\"></script><div><div class=\"vidyard_wrapper\" onclick=\"fn_vidyard_w1rHLYXjgE0qq7i9PW6HLA();\"><img width=\"360\" src=\"//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.jpg?\" alt=\"Player\"><div class=\"vidyard_play_button\"><a href=\"javascript:void(0);\"></a></div></div></div>",

  "iframe": "<iframe class=\"vidyard_iframe\" src=\"//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.html?v=3.0\" width=\"640\" height=\"360\" scrolling=\"no\" frameborder=\"0\" allowtransparency=\"true\"></iframe>",

  "sharing_page": "http://secure.vidyard.com/share/qrYGmWuYwTmEsPnVAiplgw",

  "branded_sharing_page": "http://company.vidyard.com/share/qrYGmWuYwTmEsPnVAiplgw",

  "url": "//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.html?v=3.1.1",

  "base_url": "//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.html",

  "thumbnail": "//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.jpg?"
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

id
required

Validations:

  • Parameter has to be Integer.

custom_id
optional

When specified (and applicable) will load the specified instance of the player
Default: empty

Validations:

  • Must be a String

disable_popouts
optional

Turns off Popout Call to Actions so they will not display in the player
Default: false

Validations:

  • Parameter has to be Boolean.

disable_redirect
optional

Disable the player from redirecting if it is set to redirect on player completion
Default: false

Validations:

  • Parameter has to be Boolean.

disable_up_next
optional

Disable the Up Next overlay that displays the thumbnail and title of a player’s next chapter
Default: false

Validations:

  • Parameter has to be Boolean.

playlist_always_open
optional

If there are multiple chapters in the player the playlist will be permanently visible
Default: player setting

Validations:

  • Parameter has to be Boolean.

autoplay
optional

Causes the playlist to begin playing as soon as it has loaded
Default: player setting

Validations:

  • Parameter has to be Boolean.

control_360
optional

Show 360 controls for a 360 videos
Default: true

Validations:

  • Parameter has to be Boolean.

first_frame
optional

Causes the player to begin playing as soon as it has loaded and then immediately pause
Default: player setting

Validations:

  • Parameter has to be Boolean.

viral_sharing
optional

Displays the social sharing buttons on the player
Default: player setting

Validations:

  • Parameter has to be Boolean.

embed_button
optional

Displays the embed button on the player
Default: player setting

Validations:

  • Parameter has to be Boolean.

hide_playlist
optional

Disables the playlist in the player
Default: false

Validations:

  • Parameter has to be Boolean.

hide_html5_playlist
optional

Disables the HTML5 playlist. This can be useful to solve problems with iOS and when the playlist is causing page alignment issues.
Default: false

Validations:

  • Parameter has to be Boolean.

name_overlay
optional

Overlays the name of the video at the top of the player
Default: player setting

Validations:

  • Parameter has to be Boolean.

video_id
optional

When specified the player will begin playing the video with this video id first, otherwise the player will play the chapters in chapter order. The video_id specified must already exist in the playlist. The video_id property should not be set at the same time as the chapter property.

Validations:

  • Parameter has to be Integer.

chapter
optional

When specified the player will begin playing the chapter with this ordinal value i.e. the value 1 would play the first chapter, otherwise the player will play the chapters in chapter order. The chapter property should not be set at the same time as the video_id property.

Validations:

  • Parameter has to be Integer.

lightbox_href_text
optional

The text to used in in the embed code for lightbox
Default: <Thumbnail with play button>

Validations:

  • Must be a String

include_sharing_page
optional

Whether or not to include the embed code for the sharing page
Default: true

Validations:

  • Parameter has to be Boolean.

include_branded_sharing_page
optional

Whether or not to include the embed code for the branded sharing page
Default: false

Validations:

  • Parameter has to be Boolean.


GET https://api.vidyard.com/dashboard/v1/players/uuid=:uuid/embed_codes
Get a player's embed codes by UUID

Also see "GET player embed codes" for examples.

Get a player’s embed codes by UUID. Any parameter not specified will default to the settings chosen for the player.

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

uuid
required

Validations:

  • Must be a String

custom_id
optional

When specified (and applicable) will load the specified instance of the player
Default: empty

Validations:

  • Must be a String

disable_popouts
optional

Turns off Popout Call to Actions so they will not display in the player
Default: false

Validations:

  • Parameter has to be Boolean.

disable_redirect
optional

Disable the player from redirecting if it is set to redirect on player completion
Default: false

Validations:

  • Parameter has to be Boolean.

disable_up_next
optional

Disable the Up Next overlay that displays the thumbnail and title of a player’s next chapter
Default: false

Validations:

  • Parameter has to be Boolean.

playlist_always_open
optional

If there are multiple chapters in the player the playlist will be permanently visible
Default: player setting

Validations:

  • Parameter has to be Boolean.

autoplay
optional

Causes the playlist to begin playing as soon as it has loaded
Default: player setting

Validations:

  • Parameter has to be Boolean.

control_360
optional

Show 360 controls for a 360 videos
Default: true

Validations:

  • Parameter has to be Boolean.

first_frame
optional

Causes the player to begin playing as soon as it has loaded and then immediately pause
Default: player setting

Validations:

  • Parameter has to be Boolean.

viral_sharing
optional

Displays the social sharing buttons on the player
Default: player setting

Validations:

  • Parameter has to be Boolean.

embed_button
optional

Displays the embed button on the player
Default: player setting

Validations:

  • Parameter has to be Boolean.

hide_playlist
optional

Disables the playlist in the player
Default: false

Validations:

  • Parameter has to be Boolean.

hide_html5_playlist
optional

Disables the HTML5 playlist. This can be useful to solve problems with iOS and when the playlist is causing page alignment issues.
Default: false

Validations:

  • Parameter has to be Boolean.

name_overlay
optional

Overlays the name of the video at the top of the player
Default: player setting

Validations:

  • Parameter has to be Boolean.

video_id
optional

When specified the player will begin playing the video with this video id first, otherwise the player will play the chapters in chapter order. The video_id specified must already exist in the playlist. The video_id property should not be set at the same time as the chapter property.

Validations:

  • Parameter has to be Integer.

chapter
optional

When specified the player will begin playing the chapter with this ordinal value i.e. the value 1 would play the first chapter, otherwise the player will play the chapters in chapter order. The chapter property should not be set at the same time as the video_id property.

Validations:

  • Parameter has to be Integer.

lightbox_href_text
optional

The text to used in in the embed code for lightbox
Default: <Thumbnail with play button>

Validations:

  • Must be a String

include_sharing_page
optional

Whether or not to include the embed code for the sharing page
Default: true

Validations:

  • Parameter has to be Boolean.

include_branded_sharing_page
optional

Whether or not to include the embed code for the branded sharing page
Default: false

Validations:

  • Parameter has to be Boolean.


POST https://api.vidyard.com/dashboard/v1/players/:id/embed_codes
Create a player embed code (supports email personalization)

Create a player embed code (supports emails). Any parameter not specified will default to the settings chosen for the player.

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json
{
  "vyemail": "vbot@vidyard.com"
}

RESPONSE
200 (OK)
{
  "responsive_inline": "<script type=\"text/javascript\" async src=\"https://play.vidyard.com/embed/v4.js\"></script>\n<img\n  style=\"width: 100%; margin: auto; display: block;\"\n  class=\"vidyard-player-embed\"\n  src=\"https://play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.jpg\"\n  data-uuid=\"w1rHLYXjgE0qq7i9PW6HLA\"\n  data-v=\"4\"\n  data-type=\"inline\"\n/>",

  "responsive_lightbox": "<script type=\"text/javascript\" async src=\"https://play.vidyard.com/embed/v4.js\"></script>\n<img\n  style=\"width: 100%; margin: auto; display: block;\"\n  class=\"vidyard-player-embed\"\n  src=\"https://play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.jpg\"\n  data-uuid=\"w1rHLYXjgE0qq7i9PW6HLA\"\n  data-v=\"4\"\n  data-type=\"lightbox\"\n/>",

  "inline": "<script type=\"text/javascript\" id=\"vidyard_embed_code_w1rHLYXjgE0qq7i9PW6HLA\" src=\"//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.js?v=3.0&type=inline&vyetoken=c082e9eb-3f56-4488-874c-1ff5125fdb85\"></script>",

  "light_box": "<script type=\"text/javascript\" id=\"vidyard_embed_code_w1rHLYXjgE0qq7i9PW6HLA\" src=\"//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.js?v=3.0&type=lightbox&vyetoken=c082e9eb-3f56-4488-874c-1ff5125fdb85\"></script><div><div class=\"vidyard_wrapper\" onclick=\"fn_vidyard_w1rHLYXjgE0qq7i9PW6HLA();\"><img width=\"360\" src=\"//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.jpg?\" alt=\"Player\"><div class=\"vidyard_play_button\"><a href=\"javascript:void(0);\"></a></div></div></div>",

  "iframe": "<iframe class=\"vidyard_iframe\" src=\"//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.html?v=3.0&vyetoken=c082e9eb-3f56-4488-874c-1ff5125fdb85\" width=\"640\" height=\"360\" scrolling=\"no\" frameborder=\"0\" allowtransparency=\"true\"></iframe>",

  "sharing_page": "http://secure.vidyard.com/share/qrYGmWuYwTmEsPnVAiplgw?vyetoken=c082e9eb-3f56-4488-874c-1ff5125fdb85",

  "branded_sharing_page": "http://company.vidyard.com/share/qrYGmWuYwTmEsPnVAiplgw?vyetoken=c082e9eb-3f56-4488-874c-1ff5125fdb85",

  "url": "//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.html?v=3.1.1&vyetoken=c082e9eb-3f56-4488-874c-1ff5125fdb85",

  "base_url": "//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.html",

  "thumbnail": "//play.vidyard.com/w1rHLYXjgE0qq7i9PW6HLA.jpg?"
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

id
required

Validations:

  • Parameter has to be Integer.

vyemail
optional

Personalizes the embed codes to the given email (will add vyetoken representing the email).

Validations:

  • Must be a String

custom_id
optional

When specified (and applicable) will load the specified instance of the player
Default: empty

Validations:

  • Must be a String

disable_popouts
optional

Turns off Popout Call to Actions so they will not display in the player
Default: false

Validations:

  • Parameter has to be Boolean.

disable_redirect
optional

Disable the player from redirecting if it is set to redirect on player completion
Default: false

Validations:

  • Parameter has to be Boolean.

disable_up_next
optional

Disable the Up Next overlay that displays the thumbnail and title of a player’s next chapter
Default: false

Validations:

  • Parameter has to be Boolean.

playlist_always_open
optional

If there are multiple chapters in the player the playlist will be permanently visible
Default: player setting

Validations:

  • Parameter has to be Boolean.

autoplay
optional

Causes the playlist to begin playing as soon as it has loaded
Default: player setting

Validations:

  • Parameter has to be Boolean.

control_360
optional

Show 360 controls for a 360 videos
Default: true

Validations:

  • Parameter has to be Boolean.

first_frame
optional

Causes the player to begin playing as soon as it has loaded and then immediately pause
Default: player setting

Validations:

  • Parameter has to be Boolean.

viral_sharing
optional

Displays the social sharing buttons on the player
Default: player setting

Validations:

  • Parameter has to be Boolean.

embed_button
optional

Displays the embed button on the player
Default: player setting

Validations:

  • Parameter has to be Boolean.

hide_playlist
optional

Disables the playlist in the player
Default: false

Validations:

  • Parameter has to be Boolean.

hide_html5_playlist
optional

Disables the HTML5 playlist. This can be useful to solve problems with iOS and when the playlist is causing page alignment issues.
Default: false

Validations:

  • Parameter has to be Boolean.

name_overlay
optional

Overlays the name of the video at the top of the player
Default: player setting

Validations:

  • Parameter has to be Boolean.

video_id
optional

When specified the player will begin playing the video with this video id first, otherwise the player will play the chapters in chapter order. The video_id specified must already exist in the playlist. The video_id property should not be set at the same time as the chapter property.

Validations:

  • Parameter has to be Integer.

chapter
optional

When specified the player will begin playing the chapter with this ordinal value i.e. the value 1 would play the first chapter, otherwise the player will play the chapters in chapter order. The chapter property should not be set at the same time as the video_id property.

Validations:

  • Parameter has to be Integer.

lightbox_href_text
optional

The text to used in in the embed code for lightbox
Default: <Thumbnail with play button>

Validations:

  • Must be a String

include_sharing_page
optional

Whether or not to include the embed code for the sharing page
Default: true

Validations:

  • Parameter has to be Boolean.

include_branded_sharing_page
optional

Whether or not to include the embed code for the branded sharing page
Default: false

Validations:

  • Parameter has to be Boolean.


POST https://api.vidyard.com/dashboard/v1/players/uuid=:uuid/embed_codes
Create a player embed codes by UUID (supports email personalization)

Also see "POST player embed codes" for examples.

Create a player embed codes by UUID (supports email personalization). Any parameter not specified will default to the settings chosen for the player.

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

uuid
required

Validations:

  • Must be a String

vyemail
optional

Personalizes the embed codes to the given email (will add vyetoken representing the email).

Validations:

  • Must be a String

custom_id
optional

When specified (and applicable) will load the specified instance of the player
Default: empty

Validations:

  • Must be a String

disable_popouts
optional

Turns off Popout Call to Actions so they will not display in the player
Default: false

Validations:

  • Parameter has to be Boolean.

disable_redirect
optional

Disable the player from redirecting if it is set to redirect on player completion
Default: false

Validations:

  • Parameter has to be Boolean.

disable_up_next
optional

Disable the Up Next overlay that displays the thumbnail and title of a player’s next chapter
Default: false

Validations:

  • Parameter has to be Boolean.

playlist_always_open
optional

If there are multiple chapters in the player the playlist will be permanently visible
Default: player setting

Validations:

  • Parameter has to be Boolean.

autoplay
optional

Causes the playlist to begin playing as soon as it has loaded
Default: player setting

Validations:

  • Parameter has to be Boolean.

control_360
optional

Show 360 controls for a 360 videos
Default: true

Validations:

  • Parameter has to be Boolean.

first_frame
optional

Causes the player to begin playing as soon as it has loaded and then immediately pause
Default: player setting

Validations:

  • Parameter has to be Boolean.

viral_sharing
optional

Displays the social sharing buttons on the player
Default: player setting

Validations:

  • Parameter has to be Boolean.

embed_button
optional

Displays the embed button on the player
Default: player setting

Validations:

  • Parameter has to be Boolean.

hide_playlist
optional

Disables the playlist in the player
Default: false

Validations:

  • Parameter has to be Boolean.

hide_html5_playlist
optional

Disables the HTML5 playlist. This can be useful to solve problems with iOS and when the playlist is causing page alignment issues.
Default: false

Validations:

  • Parameter has to be Boolean.

name_overlay
optional

Overlays the name of the video at the top of the player
Default: player setting

Validations:

  • Parameter has to be Boolean.

video_id
optional

When specified the player will begin playing the video with this video id first, otherwise the player will play the chapters in chapter order. The video_id specified must already exist in the playlist. The video_id property should not be set at the same time as the chapter property.

Validations:

  • Parameter has to be Integer.

chapter
optional

When specified the player will begin playing the chapter with this ordinal value i.e. the value 1 would play the first chapter, otherwise the player will play the chapters in chapter order. The chapter property should not be set at the same time as the video_id property.

Validations:

  • Parameter has to be Integer.

lightbox_href_text
optional

The text to used in in the embed code for lightbox
Default: <Thumbnail with play button>

Validations:

  • Must be a String

include_sharing_page
optional

Whether or not to include the embed code for the sharing page
Default: true

Validations:

  • Parameter has to be Boolean.

include_branded_sharing_page
optional

Whether or not to include the embed code for the branded sharing page
Default: false

Validations:

  • Parameter has to be Boolean.


GET https://api.vidyard.com/dashboard/v1/players/:id/download_links
Get a player's download links


GET https://api.vidyard.com/dashboard/v1/players/uuid=:uuid/download_links
Get a player's download links by UUID

Also see "GET player download links" for examples.

POST https://api.vidyard.com/dashboard/v1/players/:id/youtube_push
Push a player to YouTube

Push a player to YouTube

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Content-Type: application/json
{
  "channel_id": "GGh3dAgDwNXR1whyLT1a5MfA",
  "scheduled_timestamp": "1374178204",
  "privacy_setting": "private",
  "embeddable_setting": true
}

RESPONSE
200 (OK)

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

id
required

Validations:

  • Parameter has to be Integer.

channel_id
required

YouTube channel id

Validations:

  • Must be a String

privacy_setting
optional

YouTube privacy setting
Default: public

Validations:

  • Must be one of: public, private, unlisted.

embeddable_setting
optional

Whether the youtube videos created for this player can be embedded in iframes

Validations:

  • Parameter has to be Boolean.

scheduled_timestamp
optional

Timestamp (Unix Time)
Default: Now

Validations:

  • Parameter has to be TimeStamp.


POST https://api.vidyard.com/dashboard/v1/players/:uuid/duplicate
Duplicate a player

Duplicate player.

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json

RESPONSE
202 (ACCEPTED)
[
  "player_status": "duplicating",
]

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

uuid
required

The UUID of the player you want to duplicate

Validations:

  • Must be a String

organization_id
optional , nil allowed

The organization the player will be copied to
Default: Your current organization

Validations:

  • Parameter has to be Integer.

player_name
optional

The name which should be given to the duplicate player
Default: Original player name with ‘(copy)’ appended to it

Validations:

  • Must be a String

duplicate_videos
optional

Whether or not videos should be duplicated for the player. This will be true when copying to an organization other than your current active organization.
Default: false

Validations:

  • Must be one of: true, false, 1, 0.


POST https://api.vidyard.com/dashboard/v1/players/sets
Create a Set of Players from a list of uuids or tags

Use a list of uuids or tags to create a set of players

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json
RESPONSE
201 (Created)
[
  "players": [
    {
      "id": 1111,
      "uuid": "eQSsPVXinqGoesujP2Vteg",
      "name": "My Player",
      ...
    },
      "id": 1156,
      "uuid": "YBQpV0CPF5ht1UGj0qPHQQ",
      "name": "My Player",
      ...
    }
  ],
  "summary": {
    "page": 1,
    "per_page": 2,
    "count": 4
  }
]

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

uuids
optional , nil allowed

A list of uuids to select players from

Validations:

  • Must be an array of any type

tag_attributes
optional , nil allowed

A list of tags that can be used to select players which have been assigned the given tag

Validations:

  • Must be an array of any type

per_page
optional

The number of items to show per page
Maximum: 200, Default: 20

Validations:

  • Parameter has to be Integer.

page
optional

The page number to include in the response
Default: 1

Validations:

  • Parameter has to be Integer.

order_by
optional

The attribute to order the list by
Value: Must be one of: name, created_at, updated_at

Validations:

  • Must be one of: name, created_at, updated_at.

direction
optional

Only applies when order_by used
Default: asc
Value: Must be one of: asc, desc

Validations:

  • Must be one of: asc, desc.

custom_order
optional

Array of player UUIDs that specifies the ordering of the returned set.
Using this parameter will override the order_by/direction params

Validations:

  • Must be an array of any type

query
optional

Only return players which match the given query by player name, video name or tag

Validations:

  • Must be a String


GET https://api.vidyard.com/dashboard/v1/organization/:id/players/default/options
Get default player options for organization with :id

Get default player options

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json

RESPONSE
200 (OK)
{
  "mute_onload": false,
  "playlist_style": "default",
  "context_menu": true,
  "pause_disabled": false,
  "default_hd": true,
  "height": 360,
  "width": 640,
  "splash_screen_fade": true,
  "color": "7DC577",
  "play_button": true,
  "hd_button": true,
  "embed_button": true,
  "playlist_color": "222222",
  "autoplay": false,
  "chatter_only": null,
  "ignore_organization_ip_whitelist": null,
  "name_overlay": null,
  "yt_live_stream": null,
  "custom_css": null,
  "caption_color": "ffffff",
  "caption_display": "optional",
  "play_button_color": "2e2e2e",
  "ad_second": null,
  "ad_url": null,
  "hidden_controls": false,
  "render_scrubber_thumbnail": true,
  "authorized_by": "",
  "audio_player_visuals": "visualization",
  "background_style": "black",
  "up_next": true,
  "disable_default_events": false,
  "end_chapter_pause": false,
  "disable_playlist": false,
  "disable_legacy": false,
  "disable_live_dvr": false,
  "playlist_always_open": false
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String