POST https://api.vidyard.com/dashboard/v1/organizations/:current_organization_id/live DEPRECATED
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.