VideoUpdatePayload

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/api-video/json-schema/api-video-video-update-payload-schema.json",
  "title": "VideoUpdatePayload",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/api-video-videos-api-openapi.yml#/components/schemas/video-update-payload",
  "type": "object",
  "properties": {
    "playerId": {
      "type": "string",
      "x-optional-nullable": true,
      "description": "The unique ID for the player you want to associate with your video."
    },
    "title": {
      "type": "string",
      "description": "The title you want to use for your video."
    },
    "description": {
      "type": "string",
      "description": "A brief description of the video."
    },
    "public": {
      "type": "boolean",
      "description": "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": {
      "type": "boolean",
      "description": "Whether the video is a 360 degree or immersive video."
    },
    "mp4Support": {
      "type": "boolean",
      "description": "Whether the player supports the mp4 format."
    },
    "tags": {
      "type": "array",
      "description": "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.",
      "items": {
        "type": "string"
      }
    },
    "metadata": {
      "type": "array",
      "description": "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.",
      "items": {
        "$ref": "#/$defs/metadata"
      }
    },
    "language": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "ar",
        "ca",
        "cs",
        "da",
        "de",
        "el",
        "en",
        "es",
        "fa",
        "fi",
        "fr",
        "he",
        "hi",
        "hr",
        "hu",
        "it",
        "ja",
        "ko",
        "ml",
        "nl",
        "nn",
        "no",
        "pl",
        "pt",
        "ru",
        "sk",
        "sl",
        "te",
        "tr",
        "uk",
        "ur",
        "vi",
        "zh"
      ],
      "description": "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.\n\n`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": {
      "type": "boolean",
      "description": "Use this parameter to enable transcription. \n\n- When `true`, the API generates a transcript for the video.\n- The default value is `false`.\n- 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. \n- When the API generates a transcript, it will be available as a caption for the video."
    },
    "transcriptSummary": {
      "type": "boolean",
      "description": "Use this parameter to enable summarization. \n\n- When `true`, the API generates a summary for the video, based on the transcription.\n- The default value is `false`.\n- 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": {
      "description": "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`.",
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "abstract",
          "takeaways"
        ]
      }
    }
  },
  "$defs": {
    "metadata": {
      "title": "Metadata",
      "type": "object",
      "properties": {
        "key": {
          "type": "string",
          "description": "The constant that defines the data set."
        },
        "value": {
          "type": "string",
          "description": "A variable which belongs to the data set."
        }
      },
      "x-client-all-args-constructor": true
    }
  }
}