Sign in
Videos

Create a video object

Creates a video object. More information on video objects can be found here.

post/videos

Request body

titlestring required

The title of your new video.

descriptionstring

A brief description of your video.

sourcestring

You can either add a video already on the web, by entering the URL of the video, or you can also enter the videoId of one of the videos you already have on your api.video acccount, and this will generate a copy of your video. Creating a copy of a video can be especially useful if you want to keep your original video and trim or apply a watermark onto the copy you would create.

publicboolean

Default: True. If set to false the video will become private. More information on private videos can be found here

panoramicboolean

Indicates if your video is a 360/immersive video.

mp4Supportboolean

Enables mp4 version in addition to streamed version.

playerIdstring

The unique identification number for your video player.

tagsstring[]

A list of tags you want to use to describe your video.

Example request

{
  "title": "Maths video",
  "description": "An amazing video explaining string theory.",
  "public": false,
  "panoramic": false,
  "mp4Support": true,
  "playerId": "pl45KFKdlddgk654dspkze",
  "tags": [
    "maths",
    "string theory",
    "video"
  ],
  "metadata": [
    {
      "key": "Author",
      "value": "John Doe"
    },
    {
      "key": "Format",
      "value": "Tutorial"
    }
  ],
  "watermark": {
    "id": "watermark_1BWr2L5MTQwxGkuxKjzh6i",
    "bottom": "10px",
    "right": "10px",
    "width": "50%",
    "opacity": "70%"
  }
}

Response

Created

videoIdstring required

The unique identifier of the video object.

createdAtstring date-time

When a video was created, presented in ISO-8601 format.

titlestring

The title of the video content.

descriptionstring

A description for the video content.

publishedAtstring date-time

The date and time the API created the video. Date and time are provided using ISO-8601 UTC format.

updatedAtstring date-time

The date and time the video was updated. Date and time are provided using ISO-8601 UTC format.

tagsstring[]

One array of tags (each tag is a string) in order to categorize a video. Tags may include spaces.

playerIdstring

The id of the player that will be applied on the video.

publicboolean

Defines if the content is publicly reachable or if a unique token is needed for each play session. Default is true. Tutorials on private videos.

panoramicboolean

Defines if video is panoramic.

mp4Supportboolean

This lets you know whether mp4 is supported. If enabled, an mp4 URL will be provided in the response for the video.

Example response

{
  "videoId": "vi4k0jvEUuaTdRAEjQ4Jfrgz",
  "title": "Maths video",
  "description": "An amazing video explaining the string theory",
  "tags": [
    "maths",
    "string theory",
    "video"
  ],
  "metadata": [
    {
      "key": "Author",
      "value": "John Doe"
    },
    {
      "key": "Format",
      "value": "Tutorial"
    }
  ],
  "createdAt": "4251-03-03T12:52:03.085Z",
  "publishedAt": "4665-07-14T23:36:18.598Z",
  "actions": [
    "video_delete",
    "video_download",
    "video_update"
  ]
}

Changes