Live Stream Management

Update live stream provisioning data.

Supported Formats

json
>>>

POST https://api.vidyard.com/dashboard/v1/organizations/:current_organization_id/live
Create a new live stream

Create a new live stream and provision using the provided settings.

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
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
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
POST /v1/organizations/15/live
Content-Type: application/json
{
  "stream_options": {
    "recurring": false,
  },
  "video_options": {
    "video_name": "Recounting VBot's Birthday Bash",
    "description": "Join us for a live recounting of VBot's birthday bash!",
    "air_date": "2021-03-27T09:57:35+00:00",
    "segment_length": 4,
    "has_redundant_streams": true,
    "disable_notifications": false,
    "stream_tags": ["BirthdayTag", "VBot"],
    "dvr_enabled": true,
  },
}

RESPONSE
201 (Created)
{
  "stream_instance_id":	153
}

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
recurring
optional

Validations:

  • Parameter has to be Boolean.
video_name
required

Stream name

Validations:

  • Must be a String
description
required

Stream description

Validations:

  • Must be a String
air_date
optional

The date/time the stream is set to air.

Validations:

  • Parameter has to be DateTime.
segment_length
optional

Duration of segment files in seconds. Smaller number will be more live, but will cause more viewer buffering.

Validations:

  • Must be one of: 1, 4, 10, 1, 4, 10.
has_redundant_streams
optional

Determines whether backup ingestion credentials are created. Must have feature enabled for your organization for this parameter.

Validations:

  • Parameter has to be Boolean.
disable_notifications
optional

Should email notifications be enabled for this stream?

Validations:

  • Parameter has to be Boolean.
stream_tags
required

Tags to describe video/stream

Validations:

  • Must be an array of any type
dvr_enabled
optional

Whether viewers can pause and rewind streamed video during the live broadcast

Validations:

  • Parameter has to be Boolean.
>>>

GET https://api.vidyard.com/dashboard/v1/organizations/:current_organization_id/live
Get organizations live streams

Get live stream library for organization

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
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
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
422 Unprocessable Entity: body has wrong attributes

Examples

 REQUEST
 GET /v1/organizations/15/live?page=1&per_page=50&states[]=finished
 Content-Type: application/json


 RESPONSE
 200
 {
   "summary":{
      "page":1,
      "per_page":50,
      "count":1
   },
   "stream_instances":[
     {
        "id":202,
        "player_id":11,
        "player_uuid":"FDcPaMBEPpKs3A9mjfDAxx",
        "name":"Live Stream 2",
        "status":"processing",
        "recurring":false,
        "air_date":0,
        "start_time":1614820644,
        "vod_created_at":1614575068,
        "created_at":1614575068,
        "updated_at":1614575068
     },
     {
        "id":203,
        "player_id":12,
        "player_uuid":"3gNuotBz2ZPVrSGw2b1yxx",
        "name":"Live Stream 3",
        "status":"unaired",
        "recurring":false,
        "air_date":0,
        "start_time":0,
        "vod_created_at":1615320459,
        "created_at":1615720460,
        "updated_at":1615720460
     },
   ]
}

 REQUEST
 GET /v1/organizations/15/live?page=1&per_page=50&states[]=upcoming,ongoing
 Content-Type: application/json

 RESPONSE
 200
 {
   "summary":{
      "page":1,
      "per_page":50,
      "count":1
   },
   "stream_instances":[
      {
         "id":201,
         "player_id":10,
         "player_uuid":"XQifG3tEE6P3gozEhsCKxx",
         "name":"Live Stream 1",
         "status":"ready",
         "recurring":false,
         "air_date":0,
         "start_time":1613575168,
         "vod_created_at":1613575068,
         "created_at":1613575068,
         "updated_at":1613575068
      }
   ]
 }

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
per_page
optional

The number of items to show per page
Maximum: 200

Validations:

  • Parameter has to be Integer.
page
optional

The page number to include in the response
Only applies when per_page used
Default: 1

Validations:

  • Parameter has to be Integer.
query
optional

A string used to search for a set a stream instances by name as well as all associated tags

Validations:

  • Must be a String
states
optional

Filter streams to the given states.
Possible values are upcoming, ongoing, finished

Validations:

  • Must be an array of [upcoming, ongoing, finished]
order_by
optional

Only works if ‘per_page’ or ‘page’ parameters are also set.
The attribute to order the list by
Value: Must be one of: created_at, updated_at, air_date, start_time

Validations:

  • Must be one of: created_at, updated_at, air_date, start_time.
direction
optional

Only works if ‘per_page’ or ‘page’ parameters are also set.
When the direction to order the list
Only applies when order_by used
Default: asc
Value: Must be one of: asc, desc

Validations:

  • Must be one of: asc, desc.
>>>

GET https://api.vidyard.com/dashboard/v1/organizations/:current_organization_id/live/:live_stream_instance_id
Get details for live stream instance

Get the details for a specific live stream instance

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
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

Examples

 REQUEST
 GET /v1/organizations/15/live/153
 Content-Type: application/json


 RESPONSE
 200
 {
   "stream_details":{
     "stream_id":101,
     "recurring":true,
     "created_at":1616772268,
     "updated_at":1616772268
   },
   "instance_details":{
     "stream_instance_id":153,
     "dvr_enabled":true,
     "ingest_url":"rtmp://guzzler.vidyard.com:1935/live",
     "stream_key":"fccc320ee3da4exxee5495ba60460ba3",
     "email":null,
     "segment_length":1,
     "has_redundant_streams":true,
     "backup_url":"rtmp://guzzler.vidyard.com:1935/live",
     "backup_key":"159396036xx1c2af70fc53831139bf33",
     "air_date":1616772226,
     "start_time":0,
     "end_time":0,
     "vod_created_at":1616772268,
     "created_at":1616772268,
     "updated_at":1616772268,
     "name":"Recounting VBot's Birthday Bash",
     "description":"Join us for a live recounting of VBot's birthday bash!",
     "tags":[
       ["BirthdayTag", "VBot"],
     ],
     "video_id":350,
     "status":"unaired",
     "player_uuid":"yNpg4xEhtqcrfb3GSBHfxx"
   }
}

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

PATCH https://api.vidyard.com/dashboard/v1/organizations/:current_organization_id/live/:live_stream_instance_id
Update/override stream instance options for organization with id.

Update stream instance options

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
PATCH /v1/organizations/15/live/153
Content-Type: application/json
{
  "description":"New Stream Description"
}

RESPONSE
200
{
  success: true
}

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
name
optional

Stream name

Validations:

  • Must be a String
description
optional

Stream description

Validations:

  • Must be a String
dvr_enabled
optional

Whether the player controls are enabled for viewers

Validations:

  • Parameter has to be Boolean.
air_date
optional

The date/time the stream is set to air.

Validations:

  • Parameter has to be DateTime.
stream_tags
optional

Tags to describe video/stream

Validations:

  • Must be an array of any type
>>>

DELETE https://api.vidyard.com/dashboard/v1/organizations/:current_organization_id/live/:live_stream_instance_id
Delete a live stream instance.

Delete a live stream instance

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
DELETE /v1/organizations/15/live/153
Content-Type: application/json

RESPONSE
200
{
  success: true
}

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

GET https://api.vidyard.com/dashboard/v1/organizations/:current_organization_id/live/:live_stream_instance_id/health
Retrieve health stats for a stream instance.

Retrieve health stats for a live stream instance

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
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

Examples

REQUEST
GET /api/v1/organizations/15/live/153/health
Content-Type: application/json

RESPONSE
200
{
  "primary":{
    "video_codec_name":"h264",
    "video_width":1920,
    "video_height":1080,
    "video_r_frame_rate":30,
    "video_bit_rate":3072000,
    "audio_codec_name":"aac",
    "audio_sample_rate":48000,
    "audio_bit_rate":147456,
    "created_at":"2021-03-14T11:14:20.000Z"
  },
  "backup":null
}

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