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 single Video.

• 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"
  }
  }]
  }
  }' \
  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,
  "expiry_date": null,
  "redirect_url": null,
  "redirect_whole_page": false,
  "color": "aaaaaa",
  "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
  },
  "id": 3333,
  "created_at": 1351277345,
  "updated_at": 1351277345
  }
  ],
  "id": 1111,
  "uuid": "ahTJDG44BrCfxOrqE-nW5Q",
  "status": null,
  "created_at": 1351277345,
  "updated_at": 1351277345
    }