How to use the Vidyard Dashboard API

The Vidyard Dashboard API allows you to programmatically manage assets in your Vidyard account. This includes players, videos, tags, video and video metadata.

The API is valuable for anyone looking to build an integration into Vidyard from other services, or if trying to manage a large volume of content programmatically.

The API supports basic Create, Read, Update and Delete (CRUD) actions.

Access your API tokens

You will need an API token to use the dashboard API. An API token is used to tell Vidyard that you are authorized to make changes to your account through the API.

Tokens are unique are to each folder in your account. For example, an API Token from one subfolder will only allow you to make changes to the assets in that folder.

Tokens are also role-based. Each role's token will only allow you to perform actions in the dashboard that your user has permission to make.

1. Sign in to Vidyard
2. From the side menu, select Admin > API Tokens
   • If needed, select Change Folder to switch into the specific folder that you want to make changes to via the API
3. Select and copy an API token. You will only see API Tokens relevant to your user's role in Vidyard
   

Formatting your API requests

The API uses JSON to format requests and responses. For each request, you should include Content-Type and Accept properties in the header with a value of application/json.

Use the auth_token parameter along with your API token to authorize requests. You can add the parameter as an attribute in the body of the request or as a query parameter in the URL. 

var settings = {
"url": "https://api.vidyard.com/endpoint?auth_token={yourToken}",
"method": "GET",
"headers": {
   "Content-Type": "application/json",
   "Accept": "application/json"
},
};

Key resources

More details on the Dashboard API as well as available endpoints can be found on Vidyard's developer documentation.