---
title: "Update a video object"
method: PATCH
path: "/videos/{videoId}"
tags: ["Videos"]
---

# Update a video object

`PATCH /videos/{videoId}`

Update the parameters associated with a video ID.

## Path parameters

- `videoId` string, required

## Request body

- VideoUpdatePayload
  - `playerId` string — The unique ID for the player you want to associate with your video.
  - `title` string — The title you want to use for your video.
  - `description` string — A brief description of the video.
  - `public` boolean — Whether the video is publicly available or not. False means it is set to private. Default is true. Tutorials on [private videos](https://api.video/blog/endpoints/private-videos/).
  - `panoramic` boolean — Whether the video is a 360 degree or immersive video.
  - `mp4Support` boolean — Whether the player supports the mp4 format.
  - `tags` string[] — 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.
  - `metadata` Metadata[] — A list (array) of dictionaries where each dictionary contains a key value pair that describes the video. As with tags, you must send the complete list of metadata you want as whatever you send here will overwrite the existing metadata for the video.
    - `key` string — The constant that defines the data set.
    - `value` string — A variable which belongs to the data set.
  - `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](https://en.wikipedia.org/wiki/IETF_language_tag) format. `language` is a permanent attribute of the video. You can update it to another language using the [`PATCH /videos/{videoId}`](https://docs.api.video/reference/api/Videos#update-a-video-object) operation. This triggers the API to generate a new transcript using a different language.
  - `transcript` boolean — 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.
  - `transcriptSummary` boolean — 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.
  - `transcriptSummaryAttributes` string[] — 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`.

## Response `200`

Success

- Video
  - `videoId` string, required — The unique identifier of the video object.
  - `createdAt` string, date-time — When a video was created, presented in ATOM UTC format.
  - `title` string — The title of the video content.
  - `description` string — A description for the video content.
  - `publishedAt` string, date-time — The date and time the API created the video. Date and time are provided using ATOM UTC format.
  - `updatedAt` string, date-time — The date and time the video was updated. Date and time are provided using ATOM UTC format.
  - `discardedAt` string, 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.
  - `deletesAt` string, 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.
  - `discarded` boolean — Returns `true` for videos you discarded when you have the Video Restore feature enabled. Returns `false` for every other video.
  - `language` string — Returns the language of a video in [IETF language tag](https://en.wikipedia.org/wiki/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.
  - `tags` string[] — One array of tags (each tag is a string) in order to categorize a video. Tags may include spaces.
  - `metadata` Metadata[] — Metadata you can use to categorise and filter videos. Metadata is a list of dictionaries, where each dictionary represents a key value pair for categorising a video.
    - `key` string — The constant that defines the data set.
    - `value` string — A variable which belongs to the data set.
  - `source` VideoSource — Source information about the video.
    - `uri` string — The URL where the video is stored.
    - `type` string
    - `liveStream` VideoSourceLiveStream — This appears if the video is from a Live Record.
      - `liveStreamId` string — The unique identifier for the live stream.
      - `links` VideoSourceLiveStreamLink[]
        - `rel` string
        - `uri` string
  - `assets` VideoAssets — Collection of details about the video object that you can use to work with the video object.
    - `hls` string, uri — This is the manifest URL. For HTTP Live Streaming (HLS), when a HLS video stream is initiated, the first file to download is the manifest. This file has the extension M3U8, and provides the video player with information about the various bitrates available for streaming.
    - `iframe` string — Code to use video from a third party website
    - `player` string, uri — Raw url of the player.
    - `thumbnail` string, uri — Poster of the video.
    - `mp4` string, uri — Available only if mp4Support is enabled. Raw mp4 url.
  - `playerId` string — The id of the player that will be applied on the video.
  - `public` boolean — 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](https://api.video/blog/endpoints/private-videos/).
  - `panoramic` boolean — Defines if video is panoramic.
  - `mp4Support` boolean — This lets you know whether mp4 is supported. If enabled, an mp4 URL will be provided in the response for the video.

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `409` — Conflict
- `429` — Too Many Requests

---

[API](https://skmtc.net/apivideo/apis/api-video.md) · [All operations](https://skmtc.net/apivideo/apis/api-video/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/apivideo/api-video/versions/45ec26f342b6/schema)