Create a new video

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
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Content-Type: application/json
{
  "name": "My Video",
  "upload_url": "http://myvideos.com/video.mp4",
  "description": "People hard at work, or hardly working?",
  "notes": "This video shows our old logo we should replace it soon...",
  "audio_gain": 20,
  "webhook_url": "http://callbacktest.herokuapp.com/"
}

RESPONSE
201 (Created)
{
  "id": 2222,
  "uuid": "4epPofk8TYhIanJLgZyIeA",
  "name": "My Video",
  "upload_url": "http://myvideos.com/video.mp4",
  "description": "People hard at work, or hardly working?",
  "notes": "This video shows our old logo we should replace it soon...",
  "audio_gain": 20,
  "webhook_url": "http://callbacktest.herokuapp.com/",
  "sync": true,
  "status": "uploaded",
  "error_message": null,
  "created_at": 1346961610,
  "updated_at": 1346961610
}

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

Name of the video

Validations:

  • Must be a String

description
optional

Description to be shown with the video

Validations:

  • Must be a String

notes
optional

Your notes about the video
Notes are not shown to viewers

Validations:

  • Must be a String

sync
optional

If this video is pushed to YouTube, we will keep this video’s details in sync anytime you change them on Vidyard
Default: true

Validations:

  • Parameter has to be Boolean.

approver
optional

Caption approver email

Validations:

  • Must be a String

upload_url
required

A valid URL for a media file to upload

Validations:

  • Must be a String

audio_gain
optional

Specified in dB, up to 60 or down to -60
Will be applied during encoding only
Default: 0

Validations:

  • Parameter has to be Integer.

webhook_url
optional

Webhook URL that we will send details to about this video when it has finished uploading
Read more about webhooks in the blog

Validations:

  • Must be a String

tags_attributes
optional

Advanced feature: Used for embedded tag resource creation
See an example of how to use nested resources in the getting started guide

Validations:

  • Must be an array of any type

cameratag_uuid
optional

CameraTag video UUID

Validations:

  • Must be a String