Create and update thumbnails for videos and players.

Supported Formats

json

GET https://api.vidyard.com/dashboard/v1/videos/:video_id/selected_thumbnail
Get a video's selected thumbnail

Get the selected_thumbnail for a specified 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
409 Conflict: Conflict with the current state of the resource

Examples

REQUEST
Content-Type: application/json

RESPONSE
200 (Ok)
{
  "uuid": "34Jf4iLz234v1M2TQRbg",
  "url": "https://cdn.vidyard.com/test_uuid.png",
  "created_at": 1414002317,
  "updated_at": 1414002317
}

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

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


PATCH https://api.vidyard.com/dashboard/v1.1/videos/:video_id/selected_thumbnail
Set a video's selected thumbnail

Set a video’s selected thumbnails to existing thumbnail or download and create a thumbnail from a given URL

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
422 Unprocessable Entity: body has wrong attributes

Examples

EXAMPLE Upload image from URL
REQUEST
Content-Type: application/json
{
  "url": "http://www.pictureplace.com/thumbnail.jpg"
}

RESPONSE
200 (OK)
{
  "thumbnail_type": "custom",
  "url": "http://www.pictureplace.com/thumbnail.jpg",
  "uuid": "34Jf4iLz234v1M2TQRbg",
  "created_at": 1414002317,
  "updated_at": 1414002317
}

EXAMPLE Use existing available video thumbnail
REQUEST
Content-Type: application/json
{
  "uuid": "34Jf4iLz234v1M2TQRbg"
}

RESPONSE
200 (OK)
{
  "thumbnail_type": "generated",
  "url": "http://images.cdn.com/9eJxQqf4iLz234v1M2TQRbg.png",
  "uuid": "34Jf4iLz234v1M2TQRbg",
  "created_at": 1403632462,
  "updated_at": 1403632498
}

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

Validations:

  • Parameter has to be Integer.

uuid
optional

The thumbnail to set as the selected thumbnails for this video. Thumbnail must already belong to this video.

Validations:

  • Must be a String

url
optional

A URL for an image to upload to vidyard. This creates a new thumbnail to set as the selected thumbnail for this video.

Validations:

  • Must be a String


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

Set player thumbnails to existing thumbnails or download and create thumbnails from a given URLs

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
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Content-Type: application/json
[
  {
    "url": "http://www.pictureplace.com/thumbnail.jpg",
  },
  {
    "uuid": "uuid",
  }
]

RESPONSE
200 (OK)
[
  {
    "thumbnail": {
      "thumbnail_type": "custom",
      "url": "http://www.pictureplace.com/thumbnail.jpg",
      "uuid": "new_uuid",
      "uuid": "34Jf4iLz234v1M2TQRbg",
      "created_at": 1414002317,
      "updated_at": 1414002317
    },
    "created_at": 1414002317,
    "updated_at": 1414002317
  },
  {
    "thumbnail": {
      "thumbnail_type": "generated",
      "url": "http://images.cdn.com/9eJxQqf4iLz234v1M2TQRbg.png",
      "uuid": "uuid",
      "uuid": "34Jf4iLz234v1M2TQRbg",
      "created_at": 1403632462,
      "updated_at": 1403632498
    },
    "created_at": 1413997943,
    "updated_at": 1414002049
  }
]

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

player_uuid
required

Validations:

  • Must be a String

uuid
optional

The thumbnail to add to the selected thumbnails for this player. Thumbnail must already belong to this player.
Either uuid or url must be set.

Validations:

  • Must be a String

url
optional

The URL for an image to upload to vidyard. This creates a new thumbnail to add to the selected thumbnails for this player.

Validations:

  • Must be a String


GET https://api.vidyard.com/dashboard["/v1/players/uuid=:uuid/selected_thumbnails", "/v1/player/:player_id/selected_thumbnails"]
Get a player's thumbnails

Get a player’s thumbnails

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

RESPONSE
200 (Ok)
[
  {
    "thumbnail": {
      "thumbnail_type": "custom",
      "url": "http://images.cdn.com/8FSj9sfgDG89GD9dgf34.png",
      "uuid": "34Jf4iLz234v1M2TQRbg",
      "id": 60719,
      "created_at": 1414002317,
      "updated_at": 1414002317
    },
    "created_at": 1414002317,
    "updated_at": 1414002317
  },
  {
    "thumbnail": {
      "uuid": "34Jf4iLz234v1M2TQRbg",
      "thumbnail_type": "generated",
      "url": "http://images.cdn.com/9eJxQqf4iLz234v1M2TQRbg.png",
      "id": 60681,
      "created_at": 1403632462,
      "updated_at": 1403632498
    },
    "created_at": 1413997943,
    "updated_at": 1414002049
  }
]

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

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/:video_id/thumbnails
Get thumbnails for a video

Get thumbnails for the specified 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
409 Conflict: Conflict with the current state of the resource

Examples

REQUEST
Content-Type: application/json

RESPONSE
200 (Ok)
[{
  "uuid": "34Jf4iLz234v1M2TQRbg",
  "url": "http://images.cdn.com/9eJxQqf4iLz234v1M2TQRbg.png"
  "created_at": 1414002317,
  "updated_at": 1414002317
}]

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

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


POST https://api.vidyard.com/dashboard/v1/videos/:video_id/thumbnails
Create thumbnails for a video

Create new thumbnails for the specified 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
409 Conflict: Conflict with the current state of the resource

Examples

REQUEST
Content-Type: application/json

{
  "thumbnails": [{
    "url": "http://images.cdn.com/9eJxQqf4iLz234v1M2TQRbg.png"
  }]
}

RESPONSE
201 (Created)
[{
  "uuid": "34Jf4iLz234v1M2TQRbg",
  "url": "http://images.cdn.com/9eJxQqf4iLz234v1M2TQRbg.png",
  "created_at": 1414002317,
  "updated_at": 1414002317
}]

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

url
optional

The URL for an image to upload to vidyard.

Validations:

  • Must be a String

millisecond
optional

The millisecond of the video the thumbnail is from (if applicable).

Validations:

  • Parameter has to be Integer.

duration
optional

The duration of a gif thumbnail to be created

Validations:

  • Parameter has to be Integer.


PATCH https://api.vidyard.com/dashboard/v1/videos/:video_id/selected_thumbnail DEPRECATED
Set a video's selected thumbnail

Set a video’s selected thumbnails to existing thumbnail or download and create a thumbnail from a given URL

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
422 Unprocessable Entity: body has wrong attributes

Examples

EXAMPLE Upload image from URL
REQUEST
Content-Type: application/json
{
  "url": "http://www.pictureplace.com/thumbnail.jpg"
}

RESPONSE
200 (OK)
{
  "thumbnail_type": "custom",
  "url": "http://www.pictureplace.com/thumbnail.jpg",
  "id": 60719,
  "uuid": "34Jf4iLz234v1M2TQRbg",
  "created_at": 1414002317,
  "updated_at": 1414002317
}

EXAMPLE Use existing available video thumbnail
REQUEST
Content-Type: application/json
{
  "thumbnail_id": 60681
}

RESPONSE
200 (OK)
{
  "thumbnail_type": "generated",
  "url": "http://images.cdn.com/9eJxQqf4iLz234v1M2TQRbg.png",
  "id": 60681,
  "uuid": "34Jf4iLz234v1M2TQRbg",
  "created_at": 1403632462,
  "updated_at": 1403632498
}

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

thumbnail_id
optional

The thumbnail to set as the selected thumbnails for this video. Thumbnail must already belong to this player.
Either id or url must be set.

Validations:

  • Parameter has to be Integer.

url
optional

A URL for an image to upload to vidyard. This creates a new thumbnail to set as the selected thumbnail for this video.
Either id or url must be set.

Validations:

  • Must be a String


PATCH https://api.vidyard.com/dashboard["/v1/players/uuid=:uuid/selected_thumbnails", "/v1/players/:player_id/selected_thumbnails"] DEPRECATED
Sets the player thumbnails

Set player thumbnails to existing thumbnails or download and create thumbnails from a given URLs

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
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Content-Type: application/json
[
  {
    "thumbnail_url": "http://www.pictureplace.com/thumbnail.jpg",
  },
  {
    "thumbnail_id": 60681,
  }
]

RESPONSE
200 (OK)
[
  {
    "thumbnail": {
      "thumbnail_type": "custom",
      "url": "http://www.pictureplace.com/thumbnail.jpg",
      "id": 60719,
      "uuid": "34Jf4iLz234v1M2TQRbg",
      "created_at": 1414002317,
      "updated_at": 1414002317
    },
    "created_at": 1414002317,
    "updated_at": 1414002317
  },
  {
    "thumbnail": {
      "thumbnail_type": "generated",
      "url": "http://images.cdn.com/9eJxQqf4iLz234v1M2TQRbg.png",
      "id": 60681,
      "uuid": "34Jf4iLz234v1M2TQRbg",
      "created_at": 1403632462,
      "updated_at": 1403632498
    },
    "created_at": 1413997943,
    "updated_at": 1414002049
  }
]

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

thumbnail_id
optional

The thumbnail to add to the selected thumbnails for this player. Thumbnail must already belong to this player.
Either thumbnail_id or thumbnail_url must be set.

Validations:

  • Parameter has to be Integer.

thumbnail_url
optional

The URL for an image to upload to vidyard. This creates a new thumbnail to add to the selected thumbnails for this player.

Validations:

  • Must be a String


GET https://api.vidyard.com/dashboard/v1/thumbnails/:id DEPRECATED
Get a single Thumbnail

Get a single Thumbnail

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

RESPONSE
200 (Ok)
{
  "thumbnail_type": "custom",
  "url": "https://cdn.vidyard.com/test_uuid.png",
  "id": 60719,
  "created_at": 1414002317,
  "updated_at": 1414002317
}

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