Videos

Upload a video

Ingest a video from a source or file.

post/videos/{videoId}/source

Path parameters

videoIdstring required

Enter the videoId you want to use to upload your video.

Headers

Content-Rangestring

part <part>/<total_parts> ; bytes <from_byte>-<to_byte>/<total_bytes>

Response

Created

videoIdstring required

The unique identifier of the video object.

createdAtstring date-time

When a video was created, presented in ATOM UTC 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 ATOM UTC format.

updatedAtstring date-time

The date and time the video was updated. Date and time are provided using ATOM UTC format.

discardedAtstring date-time nullable

The date and time the video was discarded. The API populates this field only if you have the Video Restore feature enabled and discard a video. Date and time are provided using ATOM UTC format.

deletesAtstring date-time nullable

The date and time the video will be permanently deleted. The API populates this field only if you have the Video Restore feature enabled and discard a video. Discarded videos are pemanently deleted after 90 days. Date and time are provided using ATOM UTC format.

discardedboolean

Returns true for videos you discarded when you have the Video Restore feature enabled. Returns false for every other video.

languagestring

Returns the language of a video in IETF language tag format. You can set the language during video creation via the API, otherwise it is detected automatically.

languageOrigin'api' | 'auto' nullable

Returns the origin of the last update on the video's language attribute.

api means that the last update was requested from the API.
auto means that the last update was done automatically by the API.

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",
  "language": "en",
  "languageOrigin": "api",
  "tags": [
    "maths",
    "string theory",
    "video"
  ],
  "metadata": [
    {
      "key": "Author",
      "value": "John Doe"
    },
    {
      "key": "Format",
      "value": "Tutorial"
    }
  ],
  "createdAt": "2024-03-03T12:52:03+00:00",
  "publishedAt": "2024-07-14T23:36:07+00:00",
  "discarded": false,
  "discardedAt": null,
  "deletesAt": null,
  "actions": [
    "video_delete",
    "video_download",
    "video_update"
  ]
}

Changes

Changed in 5 of the 50 revisions of this API.11411

Oct 8, 2024ac1f7d2cfd032See the full diff
- ○
  added the optional property language to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property languageOrigin to the response with the 201 status
  response-optional-property-added
Sep 16, 2024e68c2c97ad653See the full diff
- ○
  added the optional property deletesAt to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property discarded to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property discardedAt to the response with the 201 status
  response-optional-property-added
Apr 16, 2024ec2b79bfdc8d1See the full diff
- ○
  added the non-success response with the status 429
  response-non-success-status-added
Apr 28, 2022f9532dd3578c2See the full diff
- ○
  the endpoint scheme security apiKey was added to the API
  api-security-added
- ○
  the endpoint scheme security bearerAuth was removed from the API
  api-security-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 7, 20222a4d90a64f881143See the full diff
- ▲
  the publishedAt response's property type/format changed from string/date-time to string/ for status 201
  response-property-type-changed
- ●
  the optional response header X-RateLimit-Limit removed for the status 201
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Limit removed for the status 400
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Limit removed for the status 404
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Remaining removed for the status 201
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Remaining removed for the status 400
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Remaining removed for the status 404
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Retry-After removed for the status 201
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Retry-After removed for the status 400
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Retry-After removed for the status 404
  optional-response-header-removed
- ●
  removed the optional property deletesAt from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property discarded from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property discardedAt from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property language from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property languageOrigin from the response with the 201 status
  response-optional-property-removed
- ○
  the endpoint scheme security bearerAuth was added to the API
  api-security-added
- ○
  the endpoint scheme security apiKey was removed from the API
  api-security-removed
- ○
  removed the non-success response with the status 429
  response-non-success-status-removed
This revision also has 32 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 50 revisions, 1 has no diff computed.

Full history