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/)

Get an oEmbed response with the responsive embed code for a given URL (http://oembed.com/)

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)
{
  "type": "video",
  "version": "1.0",
  "provider_name": "Vidyard",
  "provider_url": "https://vidyard.com/",
  "url": "https://share.vidyard.com/watch/uuid,
  "title": "FRANKEN-BOT",
  "width": 480,
  "height": 270,
  "html": "<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/39iBuu1GAK3yVXVecgso1d.jpg\"\n  data-uuid=\"39iBuu1GAK3yVXVecgso1d\"\n  data-v=\"4\"\n  data-type=\"inline\"\n  data-width=\"480\"\n  data-height=\"270\"\n/>"
}

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
required

The URL to retrieve embedding information for.

Validations:

  • Must be a String
maxwidth
optional

The maximum width of the video.

Validations:

  • Parameter has to be Integer.
maxheight
optional

The maximum height of the video.

Validations:

  • Parameter has to be Integer.