Videos

View, create, update and delete Vidyard videos.

Supported Formats

json
>>>

POST https://api.vidyard.com/dashboard/v1/videos
Create a new video

Create a new video

WARNING: Using this endpoint will also automatically create an associated player with player_type equals video_facade. To create a new video, it is recommended that you use the player endpoint to instead create a new player that contains the desired video.

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 Video",
  "upload_url": "http://myvideos.com/video.mp4",
  "description": "People hard at work, or hardly working?",
  "notes": "This video shows our old logo we should replace it soon...",
  "audio_gain": 20,
  "webhook_url": "http://callbacktest.herokuapp.com/"
}

RESPONSE
201 (Created)
{
  "id": 2222,
  "uuid": "4epPofk8TYhIanJLgZyIeA",
  "name": "My Video",
  "upload_url": "http://myvideos.com/video.mp4",
  "description": "People hard at work, or hardly working?",
  "notes": "This video shows our old logo we should replace it soon...",
  "audio_gain": 20,
  "webhook_url": "http://callbacktest.herokuapp.com/",
  "sync": true,
  "status": "uploaded",
  "error_message": null,
  "created_at": 1346961610,
  "updated_at": 1346961610
}

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 video

Validations:

  • Must be a String
description
optional

Description to be shown with the video

Validations:

  • Must be a String
notes
optional

Your notes about the video
Notes are not shown to viewers

Validations:

  • Must be a String
sync
optional

If this video is pushed to YouTube, we will keep this video’s details in sync anytime you change them on Vidyard
Default: true

Validations:

  • Parameter has to be Boolean.
approver
optional

Approver email

Validations:

  • Must be a String
upload_url
required

A valid URL for a media file to upload

Validations:

  • Must be a String
audio_gain
optional

Specified in dB, up to 60 or down to -60
Will be applied during encoding only
Default: 0

Validations:

  • Parameter has to be Integer.
webhook_url
optional

Webhook URL that we will send details to about this video when it has finished uploading
Read more about webhooks in the blog

Validations:

  • Must be a String
tags_attributes
optional

Advanced feature: Used for embedded tag resource creation

Validations:

  • Must be an array of any type
cameratag_uuid
optional

CameraTag video UUID

Validations:

  • Must be a String
>>>

PATCH https://api.vidyard.com/dashboard/v1/videos/:id DEPRECATED
Update a video

Update a video

DEPRECATED: Updates to a video will be overwritten by any subsequent changes to its associated player. To make changes to the video, use the player endpoint to update the Player object instead.

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 Awesomest Video",
  "description": "They are compiling!",
  "organization_id": 20,
}

RESPONSE
200 (OK)
{
  "id": 2222,
  "organization_id": 20,
  "uuid": "4epPofk8TYhIanJLgZyIeA",
  "name": "My Awesomest Video",
  "upload_url": "http://myvideos.com/video.mp4",
  "description": "They are compiling!",
  "notes": "This video shows our old logo we should replace it soon...",
  "audio_gain": 20,
  "webhook_url": "http://callbacktest.herokuapp.com/",
  "sync": true,
  "status": "ready",
  "approver: "approver.user@organization.com",
  "error_message": null,
  "created_at": 1346961610,
  "updated_at": 1346961610
}

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 video

Validations:

  • Must be a String
description
optional

Description to be shown with the video

Validations:

  • Must be a String
notes
optional

Your notes about the video
Notes are not shown to viewers

Validations:

  • Must be a String
sync
optional

If this video is pushed to YouTube, we will keep this video’s details in sync anytime you change them on Vidyard
Default: true

Validations:

  • Parameter has to be Boolean.
approver
optional

Approver email

Validations:

  • Must be a String
>>>

DELETE https://api.vidyard.com/dashboard/v1/videos/:id DEPRECATED
Delete a video

Delete a video

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/videos/:id
Get a video

Get a video

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": 2222,
  "uuid": "4epPofk8TYhIanJLgZyIeA",
  "name": "My Video",
  "description": "People hard at work, or hardly working?",
  "notes": "This video shows our old logo we should replace it soon...",
  "audio_gain": 20,
  "webhook_url": "http://callbacktest.herokuapp.com/",
  "sync": true,
  "status": "uploaded",
  "error_message": null,
  "created_at": 1346961610,
  "updated_at": 1346961610
}

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_identifier
optional

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

Validations:

  • Must be a String
>>>

GET https://api.vidyard.com/dashboard/v1/videos/:id/encoding_status
Get the encoding status for a video

If a video is encoding, use this route to get the most up to date progress

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)
{
  "progress": {
    "state": "finished",
    "progress": 100
  },
  "video": {
    "status": "ready",
    "seconds": 34
  },
  "thumbnail_url": "//cdn-staging.vidyard.com/thumbnails/a11U3BSEoUtBmOi8y8Fn1A/06a54039f28daa3a1assa5a2a90.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.
>>>

GET https://api.vidyard.com/dashboard/v1/videos/:id/status
Get the length of a video

If a video is in progress, use this route to get the most up to date length

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)
{
  "status": "processing",
  "seconds": 45,
  "milliseconds": 45000
}

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

POST https://api.vidyard.com/dashboard/v1/videos/status/sets
Create a set of video statuses from a list of video_ids

Use a list of video_ids to create a set of statuses.

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)
{
  "videos": [
    {
      "id": 123,
      "status": "processing",
      "seconds": 30,
      "milliseconds": 30000
    },
      "id": 45,
      "status": "processing",
      "seconds": 100,
      "milliseconds": 100000
    },
    "status": {
      "page": 1,
      "per_page": 5,
      "count": 2
    }
  ]
}

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
video_ids
required

A list of video_ids to select statuses for

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

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

Get a list of videos

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
{
  "videos": [
    {
      "id": 2222,
      "uuid": "4epPofk8TYhIanJLgZyIeA",
      "name": "My Video",
      "upload_url": "http://myvideos.com/video.mp4",
      "description": "People hard at work, or hardly working?",
      "notes": "This video shows our old logo we should replace it soon...",
      "audio_gain": 20,
      "webhook_url": "http://callbacktest.herokuapp.com/",
      "sync": true,
      "status": "uploaded",
      "error_message": null,
      "created_at": 1346961610,
      "updated_at": 1346961610
    },
    {
      "id": 2245,
      "uuid": "2v2Ny2VYYH2HI_5ytJYpAA",
      "name": "My Other Video",
      ...
    }
  ],
  "summary": {
    "page": 1,
    "per_page": 2,
    "count": 100
  }
}

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
order_by
optional

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

Validations:

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

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

String used to search for a set of videos by player / video name as well as associated tags

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

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

Get a list of all videos

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
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
403 Channel not linked to account or video already pushed to channel
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Content-Type: application/json
{
  "channel_id": "GGh3dAgDwNXR1whyLT1a5MfA",
  "scheduled_timestamp": "1374178204",
  "category_id": 2,
  "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 video created can be embedded in iframes

Validations:

  • Parameter has to be Boolean.
category_id
optional

Category id to assign to the video

Validations:

  • Parameter has to be Integer.
scheduled_timestamp
optional

Timestamp (Unix Time)
Default: Now

Validations:

  • Parameter has to be TimeStamp.
>>>

GET https://api.vidyard.com/dashboard/v1/videos/:id/youtube_push_status/:channel_id
Get a videos Youtube push status

Get details of a videos youtube push

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
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
404 Video has not been pushed to youtube
403 Channel_id does not match valid youtube token
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Content-Type: application/json

RESPONSE
200 (OK)
{
  "id": 4,
  "category": 10,
  "consumer_token_id": null,
  "created_at": "2017-04-04T20:16:14Z",
  "embeddable": true,
  "is_linked": false,
  "organization_id": 19,
  "privacy_setting": "private",
  "push_errors": [],
  "pushed_at": "2017-04-04T20:16:14Z",
  "status": "pushing",
  "synced_at": "2017-04-04T20:16:14Z",
  "updated_at": "2017-04-04T20:16:14Z",
  "video_id": 13,
  "youtube_id": "youtube-id-4",
  "youtube_token_id": 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
id
required

Validations:

  • Parameter has to be Integer.
channel_id
required

YouTube channel id

Validations:

  • Must be a String
>>>

PUT https://api.vidyard.com/dashboard/v1/videos/:id/youtube_repush
Repush a video to YouTube that has failed

Repush a video 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
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
403 Video or youtube push does not exist
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Content-Type: application/json
{
  "id": 12,
  "youtube_push_id": 213
}

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.
youtube_push_id
required

Validations:

  • Parameter has to be Integer.
>>>

POST https://api.vidyard.com/dashboard/v1/videos/:id/facebook_push
Push a video to Facebook

Push a video to Facebook

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
{
  "facebook_user_id": "132969177066359",
  "node_type": "page",
  "page_id": "3141592653"
}

RESPONSE
201 (Created)
{
  "node_id": "1086494448062694",
  "facebook_user_id": "132969177066359"
}

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

The id of the video to push.

Validations:

  • Parameter has to be Integer.
facebook_user_id
required

An authenticated user’s Facebook ID.

Validations:

  • Must be a String
node_type
required

The Facebook endpoint where the video will be posted.

Validations:

  • Must be one of: wall, page.
page_id
required

A valid Facebook page id managed by the specified user.

Validations:

  • Must be a String
scheduled_publish_time
optional

Timestamp (Unix Time)
Default: Now.

Validations:

  • Parameter has to be TimeStamp.
embeddable
optional

Whether the video is embeddable. Default: true.

Validations:

  • Parameter has to be Boolean.
no_story
optional

If set to true, this will suppress feed and timeline story. Default: false.

Validations:

  • Parameter has to be Boolean.
secret
optional

If set to true, this video will not appear anywhere on Facebook and is not searchable. Default: false.

Validations:

  • Parameter has to be Boolean.
copy_description
optional

Copy video description. Default: true.

Validations:

  • Parameter has to be Boolean.
>>>

GET https://api.vidyard.com/dashboard/v1/videos/:id/chapters
All chapters containing the video

Find all the chapters that contain the video

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)
{
  "chapters": [
    {
      "position": 0,
      "player_id": 1024,
      "id": 256,
      "created_at": 1374726233,
      "updated_at": 1374835343
    },
    {
      "position": 1,
      "player_id": 2048,
      "id": 512,
      "created_at": 1374726234,
      "updated_at": 1374835343
    }
  ]
}

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