The Vidyard Dashboard API allows you to programatically 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 through the API.
- Sign in to the Vidyard platform
- From the dashboard, select Admin > API Tokens
- Copy the API token appropriate to the task you're looking to complete
API tokens are role-based. Each role's token will only allow you to perform actions in the dashboard that your role has permission to make.
For example, if you belong to a role that does not have access to billing information, you will not be able to use your role's API token to manage billing.
The API uses JSON to format requests and responses. You will need to include the following items in all API requests:
Header: “Content-Type” | Value: “application/json”
Accept: "Content-Type" | Value: "application/json"
Parameter: “auth_token” | Value: //Insert API Key found in the integrations page of the Vidyard Dashboard. This parameter can be passed as a query-string parameter in GET requests, and as a parameter in the body of any POST or PUT.
Using the dashboard API
More details on the Dashboard API as well as available endpoint can be found on Vidyard's developer documentation.