Sign in

v1

latestOpenAPI 3.0.02026-07-175989869.3 KB
Videos

Update a video object

Update the parameters associated with a video ID.

patch/videos/{videoId}

Path parameters

videoIdstring required

The video ID for the video you want to update.

Request body

playerIdstring

The unique ID for the player you want to associate with your video.

titlestring

The title you want to use for your video.

descriptionstring

A brief description of the video.

publicboolean

Whether the video is publicly available or not. False means it is set to private. Default is true. Tutorials on private videos.

panoramicboolean

Whether the video is a 360 degree or immersive video.

mp4Supportboolean

Whether the player supports the mp4 format.

tagsstring[]

A list of terms or words you want to tag the video with. Make sure the list includes all the tags you want as whatever you send in this list will overwrite the existing list for the video.

language'ar' | 'ca' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'es' | 'fa' | 'fi' | 'fr' | 'he' | 'hi' | 'hr' | 'hu' | 'it' | 'ja' | 'ko' | 'ml' | 'nl' | 'nn' | 'false' | 'pl' | 'pt' | 'ru' | 'sk' | 'sl' | 'te' | 'tr' | 'uk' | 'ur' | 'vi' | 'zh' nullable

Use this parameter to set the language of the video. When this parameter is set, the API creates a transcript of the video using the language you specify. You must use the IETF language tag format.

language is a permanent attribute of the video. You can update it to another language using the PATCH /videos/{videoId} operation. This triggers the API to generate a new transcript using a different language.

transcriptboolean

Use this parameter to enable transcription.

  • When true, the API generates a transcript for the video.
  • The default value is false.
  • If you define a video language using the language parameter, the API uses that language to transcribe the video. If you do not define a language, the API detects it based on the video.
  • When the API generates a transcript, it will be available as a caption for the video.
transcriptSummaryboolean

Use this parameter to enable summarization.

  • When true, the API generates a summary for the video, based on the transcription.
  • The default value is false.
  • If you define a video language using the language parameter, the API uses that language to summarize the video. If you do not define a language, the API detects it based on the video.
transcriptSummaryAttributesstring[]

Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. The possible values are abstract and takeaways.

Example request

{
  "playerId": "pl45KFKdlddgk654dspkze",
  "title": "String theory",
  "description": "An amazing video explaining the string theory",
  "public": false,
  "language": "en",
  "transcript": true,
  "transcriptSummary": true,
  "transcriptSummaryAttributes": [
    "abstract",
    "takeaways"
  ],
  "panoramic": false,
  "mp4Support": true,
  "tags": [
    "maths",
    "string theory",
    "video"
  ],
  "metadata": [
    {
      "key": "Author",
      "value": "John Doe"
    },
    {
      "key": "Format",
      "value": "Tutorial"
    }
  ]
}

Response

Success

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"
  ]
}