Before you begin you will need a Vidyard account and an API token. Visit https://knowledge.vidyard.com/hc/en-us/articles/360010000133-How-to-use-the-Vidyard-Dashboard-API for information on how to get your API token. Contact us at support@vidyard.com if you need any assistance.
To get started we will create a Player that contains a single Video.
Example request:
curl -H "Content-Type: application/json" \
-X POST \
-d '{
"auth_token":"MY_AUTH_TOKEN",
"player":{
"name":"My Player",
"chapters_attributes":[{
"position":0,
"video_attributes":{
"name":"My Video",
"upload_url":"http://myvideos.com/video.mp4"
}
}]
}
}' \
https://api.vidyard.com/dashboard/v1/players.json
Example response:
HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8
{
"access_code": null,
"autoplay": false,
"sharing_page_comments": true,
"sharing_page": true,
"default_hd": true,
"splash_screen_fade": true,
"mute_onload": false,
"name": "My Player",
"height": 360,
"width": 640,
"playlist_always_open": false,
"release_date": 0,
"expiry_date": null,
"redirect_url": null,
"redirect_whole_page": false,
"color": "aaaaaa",
"play_button": true,
"viral_sharing": true,
"whitelisted_embed_domains": [],
"embed_button": true,
"chapters_attributes": [
{
"position": 0,
"player_id": 1111,
"video_id": 2222,
"video_attributes": {
"name": "My Video",
"upload_url": "http://myvideos.com/video.mp4",
"description": null,
"sync": true,
"audio_gain": 0,
"webhook_url": null,
"id": 2222,
"status": null,
"error_message": null,
"created_at": 1351277345,
"updated_at": 1351277345
},
"id": 3333,
"created_at": 1351277345,
"updated_at": 1351277345
}
],
"id": 1111,
"uuid": "ahTJDG44BrCfxOrqE-nW5Q",
"status": null,
"created_at": 1351277345,
"updated_at": 1351277345
}
Resource | Description |
---|---|
GET https://api.vidyard.com/dashboard/v1/access_managers | Get a list of player access managers in your account |
Resource | Description |
---|---|
GET https://api.vidyard.com/dashboard/v1/organizations/:organization_id/allotments | Fetches allotment usage and limits for an account |
Resource | Description |
---|---|
GET https://api.vidyard.com/dashboard/v1/blacklisted_ip_ranges/:id | Get a single blacklisted ip range |
POST https://api.vidyard.com/dashboard/v1/blacklisted_ip_ranges | Create a new blacklisted ip range |
GET https://api.vidyard.com/dashboard/v1/blacklisted_ip_ranges | Get a list of blacklisted ip ranges |
DELETE https://api.vidyard.com/dashboard/v1/blacklisted_ip_ranges/:id | Delete a blacklisted ip range |
Resource | Description |
---|---|
POST https://api.vidyard.com/dashboard/v1/chapters | Create a new chapter |
PUT https://api.vidyard.com/dashboard/v1/chapters/:id | Updates a single chapter |
GET https://api.vidyard.com/dashboard/v1/chapters/:id | Get a single Chapter |
DELETE https://api.vidyard.com/dashboard/v1/chapters/:id | Delete a single Chapter |
Resource | Description |
---|---|
CREATE https://api.vidyard.com/dashboard/v1/players/uuid=:uuid/embed | Enable user access to player embed code and allow playback at embedded locations. Increases account embed allotment by 1. |
DELETE https://api.vidyard.com/dashboard/v1/players/uuid=:uuid/embed | Disable user access to player embed code and prevent playback at embedded locations. Decreases account embed allotment by 1. |
Resource | Description |
---|---|
GET https://api.vidyard.com/dashboard/v1/organizations/:id/events | Get all events belonging to your organization, with their timing information. |
POST https://api.vidyard.com/dashboard/v1/organizations/:id/events | Add a default event to a organization |
PATCH https://api.vidyard.com/dashboard/v1/organizations/:id/events/:event_id | Modify an existing organization's default event |
DELETE https://api.vidyard.com/dashboard/v1/organizations/:id/events/:event_id | Delete a default event from an organization. |
Resource | Description |
---|---|
POST https://api.vidyard.com/dashboard/v1/events | Create a new event |
GET https://api.vidyard.com/dashboard/v1/events | Get all events belonging to your organization. |
GET https://api.vidyard.com/dashboard/v1/events/search | Search for events belonging to your organization. |
POST https://api.vidyard.com/dashboard/vi/events/:id/duplicate | Make a copy of an event. |
GET https://api.vidyard.com/dashboard/v1/events/:id | Get a single event. |
GET https://api.vidyard.com/dashboard/v1/events/:id/owner_meta | Get information about events attached to chapters |
PATCH https://api.vidyard.com/dashboard/v1/events/:id | Update an event. |
DELETE https://api.vidyard.com/dashboard/v1/events/:id | Delete an event |
GET https://api.vidyard.com/dashboard/v1/players/uuid=:uuid/event_meta | Get the event metadata for a player |
POST https://api.vidyard.com/dashboard/v1/players/uuid=:uuid/events | Add an event to a player by UUID |
Resource | Description |
---|---|
POST https://api.vidyard.com/dashboard/v1/gdpr_requests | Submit a GDPR request to Vidyard on behalf of an account |
Resource | Description |
---|---|
GET https://api.vidyard.com/dashboard/v1/hubs/:id/categories | List all categories for a hub |
Resource | Description |
---|---|
GET https://api.vidyard.com/dashboard/v1/hubs | List all hubs |
GET https://api.vidyard.com/dashboard/v1/hubs/:id/sitemap | Get the sitemap url for a given hub ID |
Resource | Description |
---|---|
GET https://api.vidyard.com/dashboard/v1/integrations | Get an organization's integration tokens |
GET https://api.vidyard.com/dashboard/v1/integrations/summary | Get an organization's summary of integration tokens |
Resource | Description |
---|---|
GET https://api.vidyard.com/dashboard/v1/organizations/:id | Get a single Organization |
PATCH https://api.vidyard.com/dashboard/v1/organizations/:id | Update attributes on an organization |
GET https://api.vidyard.com/dashboard/v1/accounts | View all accounts associated with auth token |
GET https://api.vidyard.com/dashboard/v1/organizations | View all organizations accessible by this user |
GET https://api.vidyard.com/dashboard/v1/organizations/:id/family | View all organizations accessible by this user within a family |
Resource | Description |
---|---|
GET https://api.vidyard.com/dashboard/v1/roles | A list of all roles |
GET https://api.vidyard.com/dashboard/v1/roles/:id | Get a role within the current organization by id |
GET https://api.vidyard.com/dashboard/v1/roles/current | Get the role associated with the current auth token |
Resource | Description |
---|---|
GET https://api.vidyard.com/dashboard/v1 | Get the playback_domain and embed_domain from the Dashboard |
Resource | Description |
---|---|
GET https://api.vidyard.com/dashboard/v1/generate_script | Generates a video script. |
Resource | Description |
---|---|
POST https://api.vidyard.com/dashboard/v1/tags | Create a new tag |
GET https://api.vidyard.com/dashboard/v1/tags/:id | Get a single tag |
GET https://api.vidyard.com/dashboard/v1/tags | Get one or more tags |
GET https://api.vidyard.com/dashboard/v1/videos/:video_id/tags
DEPRECATED
|
Get all tags for a Video |
GET https://api.vidyard.com/dashboard/v1/players/:player_id/tags | Get all tags for a Player |
GET https://api.vidyard.com/dashboard/v1/tags/names | Get all distinct tag names |
PATCH https://api.vidyard.com/dashboard/v1/videos/:video_id/tags
DEPRECATED
|
Update a Video's tags |
PATCH https://api.vidyard.com/dashboard/v1/players/:player_id/tags | Update a Player's tags |
DELETE https://api.vidyard.com/dashboard/v1/tags | Delete tags |
Resource | Description |
---|---|
GET https://api.vidyard.com/dashboard/v1/users | Gets a list of users in your account |
Resource | Description |
---|---|
GET https://api.vidyard.com/dashboard/v1/teams | Gets a list of teams in your account |
Resource | Description |
---|---|
GET https://api.vidyard.com/dashboard/v1/videos/:video_id/selected_thumbnail | Get a video's selected thumbnail |
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 |
GET https://api.vidyard.com/dashboard["/v1/players/uuid=:uuid/selected_thumbnails", "/v1/players/:player_id/selected_thumbnails"] | Get a player's thumbnails |
GET https://api.vidyard.com/dashboard/v1/videos/:video_id/thumbnails | Get thumbnails for a video |
PATCH https://api.vidyard.com/dashboard/v1/videos/:video_id/selected_thumbnail
DEPRECATED
|
Set a video's selected thumbnail |
PATCH https://api.vidyard.com/dashboard["/v1/players/uuid=:uuid/selected_thumbnails", "/v1/players/:player_id/selected_thumbnails"]
DEPRECATED
|
Sets the player thumbnails |
GET https://api.vidyard.com/dashboard/v1/thumbnails/:id
DEPRECATED
|
Get a single Thumbnail |
Resource | Description |
---|---|
GET https://api.vidyard.com/dashboard/v1/roles/:role_id/users | Gets a list of all users for a role |
GET https://api.vidyard.com/dashboard/v1/roles/:role_id/users/:id | Gets a user |
GET https://api.vidyard.com/dashboard/v1/users/:id | Gets a user |
PATCH https://api.vidyard.com/dashboard/v1/users | Updates user's information |
Resource | Description |
---|---|
GET https://api.vidyard.com/dashboard/v1/videos/:video_id/captions | Gets all captions for a video that satisfies the provided filtering and sorting parameters (if any) |
POST https://api.vidyard.com/dashboard/v1/videos/:video_id/captions | Add an SRT or VTT file to an existing video resource |
GET https://api.vidyard.com/dashboard/v1/captions/:id | Get a caption |
PATCH https://api.vidyard.com/dashboard/v1/captions/:id | Updates a caption |
GET https://api.vidyard.com/dashboard/v1/captions/:id/content/status | Get status of caption VTT content |
GET https://api.vidyard.com/dashboard/v1/captions/:id/content | Get caption VTT content |
PATCH https://api.vidyard.com/dashboard/v1/captions/:id/draft | Set caption to draft |
PATCH https://api.vidyard.com/dashboard/v1/captions/:id/publish | Set caption to published |
DELETE https://api.vidyard.com/dashboard/v1/captions/:id | Delete a caption |
Resource | Description |
---|---|
GET https://api.vidyard.com/dashboard/v1/videos/:id/files | Get the signed file urls for a video |
Resource | Description |
---|
Resource | Description |
---|---|
POST https://api.vidyard.com/dashboard/v1/organizations/:organization_id/webhooks/analytics | Registers an analytics webhook |
DELETE https://api.vidyard.com/dashboard/v1/organizations/:organization_id/webhooks/analytics/:id | Deletes an analytics webhook |
POST https://api.vidyard.com/dashboard/v1/organizations/:organization_id/webhooks/players | Registers a webhook that listens to changes on players |
DELETE https://api.vidyard.com/dashboard/v1/organizations/:organization_id/webhooks/players/:id | Delete a webhook that listens to changes on players |
Resource | Description |
---|---|
GET https://api.vidyard.com/dashboard/v1/oembed | Get an oEmbed response with the legacy embed code for a given URL (http://oembed.com/) |
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/) |
Resource | Description |
---|