POST/video/assets/update

Update a video asset

Updates an existing video asset's metadata and settings. Supply asset_id and only the properties you want to change, such as its title, description, tags, or processing options. You can also use input with the asset ID to replace the video's source.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

9 body fields

The asset identifier and the asset properties to update. asset_id is required.

asset_idstringrequired

Asset ID to update. This is a required parameter.

call_to_actionsarray<object>optional

A CTA is an explicit prompt within the video content encouraging viewers to take a particular action.

descriptionstringoptional

Attach some textual data with the asset. This field is neither searchable nor filterable.

inputstringoptional

For replacing videos, pass this along with asset_id

{workspace_id}/{asset_id}/origin-{asset_id}

metadatastringoptional

Set of key-value pairs that you can attach to this Asset. This can be useful for storing additional information.<br/> Example: <br/> <code> { "internal_video_id" : "123Abc" } </code>

remove_subtitlesarray<string>optional

Comma separated string of language codes.

reprocessbooleanoptional

To reprocess same video, pass this as true.

tagstringoptional

Specify a text string or identifier which can identify an asset or bunch of assets later. You can pass multiple comma-separated values.

titlestringoptional

Specify a text string or identifier which can be used for filtering or searching the asset.

6 status codes
200Returns an empty object after the asset is updated.
400Returned when parameters are invalid or the asset is not found.

One documented failure

  • asset_id_not_valid

    The asset ID is not valid.

errorobjectrequired
401Returned when the API key or bearer token is missing or invalid.

One documented failure

  • invalid_api_key

    API key supplied with request is invalid

errorobjectrequired
403Returned when the account is unpaid or the authenticated user lacks the required role permissions.

One documented failure

  • unauthorized

    You don't have access to this feature. Please contact your organization owner.

errorobjectrequired
404Returned when the asset is not found.

One documented failure

  • asset_not_found

    Could not find any video asset with specified asset_id.

errorobjectrequired
422Returned when request validation fails.

One documented failure

  • invalid_parameter

    body must have required property '<field>'

errorobjectrequired

Error handling

A 400 is returned for invalid parameters or an asset that is not found, a 401 when the API key or bearer token is missing or invalid, a 403 for an unpaid account or insufficient role permissions, a 404 when the asset is not found, and a 422 when request validation fails. asset_id is required; metadata must be a JSON-formatted string when supplied.