Getting Started

Before you begin you will need a Vidyard account and an API token. Visit https://knowledge.vidyard.com/hc/en-us/articles/360010000133-How-to-use-the-Vidyard-Dashboard-API for information on how to get your API token. Contact us at support@vidyard.com if you need any assistance.

To get started we will create a Player that contains a Video.

Using individual resources

Create the Video:

  • Example request:

      curl -H "Content-Type: application/json" \
    -X POST \
    -d '{
    "auth_token":"MY_AUTH_TOKEN",
    "video":{
    "name":"My Video",
    "upload_url":"http://myvideos.com/video.mp4"
    }
    }' \
    https://api.vidyard.com/dashboard/v1/videos.json
  • Example response:

      HTTP/1.1 201 Created
      Content-Type: application/json; charset=utf-8
    
      {
    "id": 2222,
    "name": "My Video",
    "upload_url": "http://myvideos.com/video.mp4",
    "description": null,
    "sync": true,
    "status": null,
    "error_message": null,
    "created_at": 1346961610,
    "updated_at": 1346961610
      }

Create a Tag for the Video:

  • Example request:

      curl -H "Content-Type: application/json" \
    -X POST \
    -d '{
    "auth_token":"MY_AUTH_TOKEN",
    "tag":{
    "name":"My Tag",
    "video_id":2222
    }
    }' \
    https://api.vidyard.com/dashboard/v1/tags.json
  • Example response:

      HTTP/1.1 201 Created
      Content-Type: application/json; charset=utf-8
    
      {
    "id": 4444,
    "name": "My Tag",
    "video_ids": [2222],
    "created_at": 1346961610,
      }

Then, we create the Player:

  • Example request:

      curl -H "Content-Type: application/json" \
    -X POST \
    -d '{
    "auth_token":"MY_AUTH_TOKEN",
    "player":{
    "name":"My Player"
    }
    }' \
    https://api.vidyard.com/dashboard/v1/players.json
  • Example response:

      HTTP/1.1 201 Created
      Content-Type: application/json; charset=utf-8
    
      {
    "id": 1111,
    "access_code": null,
    "autoplay": false,
    "sharing_page_comments": true,
    "sharing_page": null,
    "default_hd": true,
    "loop_playback": false,
    "splash_screen_fade": true,
    "mute_onload": false,
    "name": "My Player",
    "height": 360,
    "width": 640,
    "playlist_always_open": false,
    "release_date": null,
    "redirect_url": null,
    "redirect_whole_page": false,
    "color": "aaaaaa",
    "hd_button": true,
    "play_button": true,
    "viral_sharing": true,
    "whitelisted_embed_domains": [],
    "uuid": "ahTJDG44BrCfxOrqE-nW5Q",
    "status": null,
    "created_at": 1346961610,
    "updated_at": 1346961610
      }

We now have the resource id‘s of both the container (the Player) and the media (the Video). We can join them together with a Chapter.

  • Example request:

      curl -H "Content-Type: application/json" \
    -X POST \
    -d '{
    "auth_token":"MY_AUTH_TOKEN",
    "chapter":{
    "position":0,
    "player_id":1111,
    "video_id":2222
    }
    }' \
    https://api.vidyard.com/dashboard/v1/chapters.json
  • Example response:

      HTTP/1.1 201 Created
      Content-Type: application/json; charset=utf-8
    
      {
    "position": 0,
    "player_id": 1111,
    "video_id": 2222,
    "id": 3333,
    "created_at": 1346961610,
    "updated_at": 1346961610
      }

Using nested resources

  • Example request:

      curl -H "Content-Type: application/json" \
    -X POST \
    -d '{
    "auth_token":"MY_AUTH_TOKEN",
    "player":{
    "name":"My Player",
    "chapters_attributes":[{
    "position":0,
    "video_attributes":{
    "name":"My Video",
    "upload_url":"http://myvideos.com/video.mp4",
    "tags_attributes":[{
    "name":"My Tag"
    }]
    }
    }]
    }
    }' \
    https://api.vidyard.com/dashboard/v1/players.json
  • Example response:

      HTTP/1.1 201 Created
      Content-Type: application/json; charset=utf-8
    
      {
    "access_code": null,
    "autoplay": false,
    "sharing_page_comments": true,
    "sharing_page": true,
    "default_hd": true,
    "splash_screen_fade": true,
    "mute_onload": false,
    "name": "My Player",
    "height": 360,
    "width": 640,
    "playlist_always_open": false,
    "release_date": 0,
    "redirect_url": null,
    "redirect_whole_page": false,
    "color": "aaaaaa",
    "hd_button": true,
    "play_button": true,
    "viral_sharing": true,
    "whitelisted_embed_domains": [],
    "embed_button": true,
    "chapters_attributes": [
    {
    "position": 0,
    "player_id": 1111,
    "video_id": 2222,
    "video_attributes": {
    "name": "My Video",
    "upload_url": "http://myvideos.com/video.mp4",
    "description": null,
    "sync": true,
    "audio_gain": 0,
    "webhook_url": null,
    "id": 2222,
    "status": null,
    "error_message": null,
    "created_at": 1351277345,
    "updated_at": 1351277345,
    "tags_attributes": [{
    "id": 4444,
    "name": "My Tag",
    "video_ids": [2222],
    "created_at": 1346961610,
    }]
    },
    "id": 3333,
    "created_at": 1351277345,
    "updated_at": 1351277345
    }
    ],
    "final_call_to_action": "<style =text/css>body{background: white;}</style><p>This is a brand shiny new <b>Call to Action</b> for the current player!<br><br> This Call To Action will not be actively created until it is saved.</p>",
    "id": 1111,
    "uuid": "ahTJDG44BrCfxOrqE-nW5Q",
    "status": null,
    "created_at": 1351277345,
    "updated_at": 1351277345
      }

Resources

Attributes

Resource Description
GET https://api.vidyard.com/dashboard/v1/attributes Get one or more attributes
GET https://api.vidyard.com/dashboard/v1/attributes/default Get one or more default attributes
GET https://api.vidyard.com/dashboard["/v1/players/:player_id/attributes", "/v1/players/uuid=:player_uuid/attributes"] Get the custom attributes for the specified player
GET https://api.vidyard.com/dashboard/v1/videos/:video_id/attributes Get the custom attributes for the specified video
POST https://api.vidyard.com/dashboard/v1/attributes/default Create a new default attribute
POST https://api.vidyard.com/dashboard["/v1/players/:player_id/attributes", "/v1/players/uuid=:player_uuid/attributes"] Create a new player attribute
POST https://api.vidyard.com/dashboard/v1/videos/:video_id/attributes Create a new video attribute
PUT https://api.vidyard.com/dashboard/v1/attributes/default Update a default custom attribute value
PUT https://api.vidyard.com/dashboard["/v1/players/:player_id/attributes", "/v1/players/uuid=:player_uuid/attributes"] Update a player custom attribute value
PUT https://api.vidyard.com/dashboard/v1/videos/:video_id/attributes Update a video custom attribute value
DELETE https://api.vidyard.com/dashboard/v1/attributes/:name Delete all instances of a custom attribute
DELETE https://api.vidyard.com/dashboard/v1/attributes/default/:name Delete a default custom attribute value
DELETE https://api.vidyard.com/dashboard["/v1/players/:player_id/attributes/:name", "/v1/players/uuid=:player_uuid/attributes/:name"] Delete a custom attribute value for specified player
DELETE https://api.vidyard.com/dashboard/v1/videos/:video_id/attributes/:name Delete a custom attribute value for specified video

Billing Plan

Resource Description
GET https://api.vidyard.com/dashboard/v1/billing_plan Get the billing plan for an account

Blacklisted IP Ranges

Resource Description
GET https://api.vidyard.com/dashboard/v1/blacklisted_ip_ranges/:id Get a single blacklisted ip range
POST https://api.vidyard.com/dashboard/v1/blacklisted_ip_ranges Create a new blacklisted ip range
GET https://api.vidyard.com/dashboard/v1/blacklisted_ip_ranges Get a list of blacklisted ip ranges
DELETE https://api.vidyard.com/dashboard/v1/blacklisted_ip_ranges/:id Delete a blacklisted ip range

Brand Watermarks

Resource Description
GET https://api.vidyard.com/dashboard/v1/brand_watermarks/active Get an organization's active brand watermark

Chapters

Resource Description
POST https://api.vidyard.com/dashboard/v1/chapters Create a new chapter
PUT https://api.vidyard.com/dashboardv1/chapters/:id Updates a single chapter
GET https://api.vidyard.com/dashboard/v1/chapters/:id Get a single Chapter
DELETE https://api.vidyard.com/dashboard/v1/chapters/:id Delete a single Chapter

Call To Actions

Resource Description
POST https://api.vidyard.com/dashboard/v1/ctas Create a new call to action
POST https://api.vidyard.com/dashboard/v1/ctas/default_email_gate Create a default email gate call to action
PATCH https://api.vidyard.com/dashboard/v1/ctas/:id Update a call to action
GET https://api.vidyard.com/dashboard/v1/ctas/:id Get a single call to action
GET https://api.vidyard.com/dashboard/v1/chapters/:id/ctas Get all popout call to actions for a chapter
GET https://api.vidyard.com/dashboard/v1/players/:id/ctas Get all popout call to actions for a player
GET https://api.vidyard.com/dashboard/v1/players/uuid=:uuid/ctas Get all popout call to actions for a player by UUID
DELETE https://api.vidyard.com/dashboard/v1/ctas/:id Delete a call to action
GET https://api.vidyard.com/dashboard/v1/players/:id/cta_meta Get popout call to action meta data for a player
GET https://api.vidyard.com/dashboard/v1/players/uuid=:uuid/cta_meta Get popout call to action meta data for a player by UUID

Event Joins

Resource Description
GET https://api.vidyard.com/dashboard/v1/chapters/:id/events Get all events belonging to a chapter, with their timing information.
GET https://api.vidyard.com/dashboard/v1/organizations/:id/events Get all events belonging to your organization, with their timing information.
POST https://api.vidyard.com/dashboard/v1/chapters/:id/events Add an event to a chapter
POST https://api.vidyard.com/dashboard/v1/organizations/:id/events Add a default event to a organization
POST https://api.vidyard.com/dashboard/v1/events/:id/bulk_associate_events Add an event to various chapters in an organization
POST https://api.vidyard.com/dashboard/v1/chapters/:id/bulk_associate_events Add a series of events to a chapter
PATCH https://api.vidyard.com/dashboardv1/chapters/:id/events/:event_id Modify an existing chapter's event
PATCH https://api.vidyard.com/dashboardv1/orgnizations/:id/events/:event_id Modify an existing organization's default event
DELETE https://api.vidyard.com/dashboardv1/chapters/:id/events/:event_id Delete an event from a chapter.
DELETE https://api.vidyard.com/dashboardv1/organizations/:id/events/:event_id Delete a default event from an organization.

Events

Resource Description
POST https://api.vidyard.com/dashboard/v1/events Create a new event
GET https://api.vidyard.com/dashboard/v1/events Get all events belonging to your organization.
GET https://api.vidyard.com/dashboard/v1/events/search Search for events belonging to your organization.
POST https://api.vidyard.com/dashboard/vi/events/:id/duplicate Make a copy of an event.
GET https://api.vidyard.com/dashboard/v1/events/:id Get a single event.
GET https://api.vidyard.com/dashboardv1/events/:id/owner_meta Get information about events attached to chapters
PATCH https://api.vidyard.com/dashboard/v1/events/:id Update an event.
DELETE https://api.vidyard.com/dashboard/v1/events/:id Delete an event
GET https://api.vidyard.com/dashboard/v1/players/uuid=:uuid/event_meta Get the event metadata for a player

Features

Resource Description
GET https://api.vidyard.com/dashboard/v1/features Get an organization's available features
GET https://api.vidyard.com/dashboard/v1/features/:unique_name/organizations Get organizations having a feature
GET https://api.vidyard.com/dashboard/v1/features/:feature_id/organizations Get organizations having a feature
GET https://api.vidyard.com/dashboard/v1.1/organizations/:organization_id/features/unique_name=:unique_name Get a feature within an organization
GET https://api.vidyard.com/dashboard/v1/organizations/:organization_id/features/unique_name=:unique_name DEPRECATED Get a feature within an organization
GET https://api.vidyard.com/dashboard/v1/features/:unique_name/usages Get usages on a feature within an organization
GET https://api.vidyard.com/dashboard/v1/features/:feature_id/usages Get usages on a feature within an organization
GET https://api.vidyard.com/dashboard/v1/features/:unique_name/allotments Get allotments for a feature within an organization
GET https://api.vidyard.com/dashboard/v1/features/:feature_id/allotments Get allotments for a feature within an organization

Feeds

Resource Description
GET https://api.vidyard.com/dashboard/v1/feeds/uuid=:uuid Get a feed by UUID

GDPR Requests

Resource Description
POST https://api.vidyard.com/dashboard/v1/gdpr_requests Submit a GDPR request to Vidyard on behalf of an account

Hub Categories

Resource Description
GET https://api.vidyard.com/dashboard/v1/hubs/:id/categories List all categories for a hub

Hub Users

Resource Description
POST https://api.vidyard.com/dashboard/v1/hubs/:id/users Invite a new hub user
POST https://api.vidyard.com/dashboard/v1/hubs/:id/users/invitations Create an invitation for a hub user
GET https://api.vidyard.com/dashboard/v1/hubs/:id/users See all users of a hub
DELETE https://api.vidyard.com/dashboard/v1/hubs/:id/users/:hub_user_id Remove a user from the hub

Hubs

Resource Description
GET https://api.vidyard.com/dashboard/v1/hubs List all hubs
GET https://api.vidyard.com/dashboard/v1/hubs/:id/sitemap Get the sitemap url for a given hub ID

Integrations

Resource Description
GET https://api.vidyard.com/dashboard/v1/integrations Get an organization's integration tokens

Live Stream

Resource Description
POST https://api.vidyard.com/dashboard/v1/videos/live_stream Create live stream video
GET https://api.vidyard.com/dashboard/v1/videos/:id/live_stream Get live stream metadata
GET https://api.vidyard.com/dashboard/v1/players/uuid=:uuid/live_stream Get live stream metadata
PATCH https://api.vidyard.com/dashboard/v1/videos/:id/live_stream Update live stream settings
DELETE https://api.vidyard.com/dashboard/v1/videos/:video_id/live_stream Close a channel
DELETE https://api.vidyard.com/dashboard/v1/players/uuid=:player_uuid/live_stream Close a channel
POST https://api.vidyard.com/dashboard/v1/players/uuid=:player_uuid/live_stream Create live stream in a player
PATCH https://api.vidyard.com/dashboard/v1/players/uuid=:player_uuid/live_stream Update live stream settings

Organizations

Resource Description
GET https://api.vidyard.com/dashboard/v1/organizations/:id Get a single Organization
PATCH https://api.vidyard.com/dashboard/v1/organizations/:id Update attributes on an organization
GET https://api.vidyard.com/dashboard/v1/accounts View all accounts associated with auth token
GET https://api.vidyard.com/dashboard/v1/organizations View all organizations accessible by this user
GET https://api.vidyard.com/dashboard/v1/organizations/:id/family View all organizations accessible by this user within a family
POST https://api.vidyard.com/dashboard/v1/organizations Create a new organization
POST https://api.vidyard.com/dashboard/v1/groups Create a new group
GET https://api.vidyard.com/dashboard/api/v1/organizations/:id/youtube_tokens Get an organization's youtube tokens
DELETE https://api.vidyard.com/dashboard/api/v1/organizations/:id/youtube_tokens Disconnect all Youtube accounts associated with an organization

Players

Resource Description
POST https://api.vidyard.com/dashboard/v1/players Create a new player
GET https://api.vidyard.com/dashboard/v1/players/:id Get a player
GET https://api.vidyard.com/dashboard/v1/players/uuid=:uuid Get a player by UUID
DELETE https://api.vidyard.com/dashboard/v1/players/:id Delete a player
GET https://api.vidyard.com/dashboard/v1/players Get a list of players
POST https://api.vidyard.com/dashboard/v1/categories/:id/players Add players to a category
GET https://api.vidyard.com/dashboard/v1/categories/:id/players Get the list of players for a category
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
POST https://api.vidyard.com/dashboard/v1/players/:id/access_codes Create an Access Code for Player
GET https://api.vidyard.com/dashboard/v1/players/:id/embed_codes Get a player's embed codes
GET https://api.vidyard.com/dashboard/v1/players/uuid=:uuid/embed_codes Get a player's embed codes by UUID
POST https://api.vidyard.com/dashboard/v1/players/:id/embed_codes Create a player embed code (supports email personalization)
POST https://api.vidyard.com/dashboard/v1/players/uuid=:uuid/embed_codes Create a player embed codes by UUID (supports email personalization)
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
POST https://api.vidyard.com/dashboard/v1/players/:id/youtube_push Push a player to YouTube
POST https://api.vidyard.com/dashboard/v1/players/:uuid/duplicate Duplicate a player
POST https://api.vidyard.com/dashboard/v1/players/sets Create a Set of Players from a list of uuids or tags
GET https://api.vidyard.com/dashboard/v1/organization/:id/players/default/options Get default player options for organization with :id

Roles

Resource Description
GET https://api.vidyard.com/dashboard/v1/roles A list of all roles
GET https://api.vidyard.com/dashboard/v1/roles/:id Get a role within the current organization by id
GET https://api.vidyard.com/dashboard/v1/roles/current Get the role associated with the current auth token

Dashboard

Resource Description
GET https://api.vidyard.com/dashboard/v1 Get the playback_domain and embed_domain from the Dashboard

SsoProfiles

Resource Description
GET https://api.vidyard.com/dashboard/v1/sso_profiles A list of all sso profiles and organizations they're assigned to
GET https://api.vidyard.com/dashboard/v1/sso_profiles/:uuid A sso profile and organizations it's assigned to

Tags

Resource Description
POST https://api.vidyard.com/dashboard/v1/tags Create a new tag
GET https://api.vidyard.com/dashboard/v1/tags/:id Get a single tag
GET https://api.vidyard.com/dashboard/v1/tags Get one or more tags
GET https://api.vidyard.com/dashboard/v1/videos/:video_id/tags Get all tags for a Video
GET https://api.vidyard.com/dashboard/v1/players/:player_id/tags Get all tags for a Player
GET https://api.vidyard.com/dashboard/v1/tags/names Get all distinct tag names
PATCH https://api.vidyard.com/dashboard/v1/videos/:video_id/tags Update a Video's tags
PATCH https://api.vidyard.com/dashboard/v1/players/:player_id/tags Update a Player's tags
DELETE https://api.vidyard.com/dashboard/v1/tags Delete tags

Thumbnails

Resource Description
GET https://api.vidyard.com/dashboard/v1/videos/:video_id/selected_thumbnail Get a video's selected thumbnail
PATCH https://api.vidyard.com/dashboard/v1.1/videos/:video_id/selected_thumbnail Set a video's selected thumbnail
PATCH https://api.vidyard.com/dashboard["/v1.1/players/uuid=:player_uuid/selected_thumbnails", "/v1.1/players/:player_uuid/selected_thumbnails"] Sets the player thumbnails
GET https://api.vidyard.com/dashboard["/v1/players/uuid=:uuid/selected_thumbnails", "/v1/player/:player_id/selected_thumbnails"] Get a player's thumbnails
GET https://api.vidyard.com/dashboard/v1/videos/:video_id/thumbnails Get thumbnails for a video
POST https://api.vidyard.com/dashboard/v1/videos/:video_id/thumbnails Create thumbnails for a video
PATCH https://api.vidyard.com/dashboard/v1/videos/:video_id/selected_thumbnail DEPRECATED Set a video's selected thumbnail
PATCH https://api.vidyard.com/dashboard["/v1/players/uuid=:uuid/selected_thumbnails", "/v1/players/:player_id/selected_thumbnails"] DEPRECATED Sets the player thumbnails
GET https://api.vidyard.com/dashboard/v1/thumbnails/:id DEPRECATED Get a single Thumbnail

Users

Resource Description
GET https://api.vidyard.com/dashboard/v1/roles/:role_id/users Get a list of all users for a role
GET https://api.vidyard.com/dashboard/v1/roles/:role_id/users/:id Get a user
GET https://api.vidyard.com/dashboard/v1/users/:id Get a user
DELETE https://api.vidyard.com/dashboard/v1/roles/:role_id/users/:id Remove a user from a role
POST https://api.vidyard.com/dashboard/v1/roles/:role_id/invitations Invite a new or existing user to a role
GET https://api.vidyard.com/dashboard/v1/roles/:role_id/invitations Get a list of invitations for a role
DELETE https://api.vidyard.com/dashboard/v1/roles/:role_id/invitations/:id Delete an invitation

Captions

Resource Description
GET https://api.vidyard.com/dashboard/v1/videos/:video_id/captions Get a Video's captions
PATCH https://api.vidyard.com/dashboard/v1/videos/:video_id/captions/publish Publish a video's approved captions
GET https://api.vidyard.com/dashboard/v1/captions/:id Get a caption
POST https://api.vidyard.com/dashboard/v1/videos/:video_id/captions Add an SRT or VTT file to an existing video resource
PATCH https://api.vidyard.com/dashboard/v1/captions/:id Update a caption
GET https://api.vidyard.com/dashboard/v1/captions/:id/content Get caption VTT content
PATCH https://api.vidyard.com/dashboard/v1/captions/:id/draft Set caption to draft
PATCH https://api.vidyard.com/dashboard/v1/captions/:id/approve Set caption to approved
DELETE https://api.vidyard.com/dashboard/v1/captions/:id Delete a caption

Api video files

Resource Description
GET https://api.vidyard.com/dashboard/v1/videos/:id/files Get the signed file urls for a video

Videos

Resource Description
POST https://api.vidyard.com/dashboard/v1/videos Create a new video
PATCH https://api.vidyard.com/dashboard/v1/videos/:id Update a video
DELETE https://api.vidyard.com/dashboard/v1/videos/:id Delete a video
GET https://api.vidyard.com/dashboard/v1/videos/:id Get a video
GET https://api.vidyard.com/dashboard/v1/videos/:id/encoding_status Get the encoding status for a video
GET https://api.vidyard.com/dashboard/v1/videos/:id/status Get the length of a video
POST https://api.vidyard.com/dashboard/v1/videos/status/sets Create a set of video statuses from a list of video_ids
GET https://api.vidyard.com/dashboard/v1/videos Get a list of videos
POST https://api.vidyard.com/dashboard/v1/videos/:id/youtube_push Push a video to YouTube
GET https://api.vidyard.com/dashboard/v1/videos/:id/youtube_push_status/:channel_id Get a videos Youtube push status
PUT https://api.vidyard.com/dashboard/v1/videos/:id/youtube_repush Repush a video to YouTube that has failed
POST https://api.vidyard.com/dashboard/v1/videos/:id/facebook_push Push a video to Facebook
GET https://api.vidyard.com/dashboard/v1/videos/:id/chapters All chapters containing the video
POST https://api.vidyard.com/dashboard/v1/videos/:id/youtube_link Link a video

Oembed

Resource Description
GET https://api.vidyard.com/dashboard/v1/oembed Get an oEmbed response with the legacy embed code for a given URL (http://oembed.com/)
GET https://api.vidyard.com/dashboard/v1.1/oembed Get an oEmbed response with the responsive embed code for a given URL (http://oembed.com/)