Advanced Commands
Advanced asset operations including clipping, archiving, annotations, sharing, transcription, and more.
Advanced Commands
These commands provide advanced asset operations beyond the core upload/download workflow. All commands accept assets by --id, --url (bucket::object-key), or --object-key (requires default bucket set via set-default-bucket).
Asset Lifecycle Commands
archive-asset
Archives an asset.
Options:
--id: Asset ID.--url: Nomad Media URL (bucket::object-key).--object-key: Object-key (requires default bucket).
restore-asset
Restores an archived asset.
Options:
--id: Asset ID.--url: Nomad Media URL (bucket::object-key).--object-key: Object-key (requires default bucket).
local-restore-asset
Restores an asset locally using a specific profile.
Options:
--id: Asset ID.--url: Nomad Media URL (bucket::object-key).--object-key: Object-key (requires default bucket).--profile(required): Restore profile name.
reprocess-asset
Reprocesses one or more assets through the media pipeline.
Options:
--target-ids(optional, multiple): Target asset IDs.--target-urls(optional, multiple): Target Nomad Media URLs (bucket::object-key).--target-object-keys(optional, multiple): Target object-keys (requires default bucket).
register-asset
Registers an asset in Nomad Media (typically after a direct S3 upload).
Options:
--id,--url,--object-key: Asset identifier.--parent-id(optional): Parent folder ID.--display-object-key(optional): Display object key.--bucket-name(optional): Bucket name.--e-tag(optional): S3 ETag.--tag-ids(optional): Tags in JSON list format.--collection-ids(optional): Collections in JSON list format.--related-content-ids(optional): Related content in JSON list format.--sequencer(optional): S3 sequencer value.--asset-status(optional): Asset status.--storage-class(optional): S3 storage class.--asset-type(optional): Asset type.--content-length(optional): File size in bytes.--storage-event-name(optional): S3 event name.--created-date(optional): Creation date.--storage-source-ip-address(optional): Source IP address.--start-media-processor(optional): Whether to start the media processor.--delete-missing-asset(optional): Whether to delete the asset if missing.
index-asset
Indexes an asset in the search index.
Options:
--id: Asset ID.--url: Nomad Media URL (bucket::object-key).--object-key: Object-key (requires default bucket).
Asset Organization Commands
copy-asset
Copies one or more assets.
Options:
--ids(optional, multiple): Asset IDs to copy.--urls(optional, multiple): Nomad Media URLs to copy.--object-keys(optional, multiple): Object-keys to copy (requires default bucket).
move-asset
Moves an asset to a different folder.
Options:
--id,--url,--object-key: Asset identifier.--destination-folder-id(required): Destination folder ID.--name(optional): New name for the asset after moving.--batch-action(optional): Batch action in JSON dict format.--content-definition-id(optional): Content definition ID.--schema-name(optional): Schema name.--resolver-exempt(optional): Resolver exempt flag.
duplicate-asset
Duplicates an asset.
Options:
--id: Asset ID.--url: Nomad Media URL (bucket::object-key).--object-key: Object-key (requires default bucket).
create-folder-asset
Creates a new folder in asset storage.
Options:
--parent-id,--url,--object-key: Parent folder identifier.--folder-name(required): Name for the new folder.
create-placeholder-asset
Creates a placeholder asset (a named slot for a file that has not yet been uploaded).
Options:
--parent-id,--url,--object-key: Parent folder identifier.--asset-name(required): Display name for the placeholder. Must include a file extension.
Media Operations
clip-asset
Creates a clip from a video asset.
Options:
--id(required): Asset ID.--url,--object-key: Asset identifier alternatives.--start-time-code(required): Clip start. Format:hh:mm:ss;ff.--end-time-code(required): Clip end. Format:hh:mm:ss;ff.--title(required): Title for the new clip.--output-folder-id(optional): Destination folder ID.--tags(optional, multiple): Tags in JSON list format —{"id": {id}, "description": {description}}.--collections(optional, multiple): Collections in JSON list format.--related-contents(optional, multiple): Related content in JSON list format.--video-bitrate(optional): Video bitrate.--audio-tracks(optional, multiple): Audio tracks in JSON list format.
build-media
Builds a new media asset from one or more sources.
Options:
--source-ids(optional, multiple): Source asset IDs in JSON list format.--source-urls(optional, multiple): Source Nomad Media URLs in JSON list format.--source-object-keys(optional, multiple): Source object-keys in JSON list format.--title(required): Title for the new media asset.--destination-folder-id(required): Destination folder ID.--tags(optional, multiple): Tags in JSON list format.--collections(optional, multiple): Collections in JSON list format.--related-contents(optional, multiple): Related content in JSON list format.--video-bitrate(optional): Video bitrate.--audio-tracks(optional, multiple): Audio tracks in JSON list format.
transcribe-asset
Submits a transcription job for a video asset.
Options:
--id,--url,--object-key: Asset identifier (must be a video).--transcript-id(required): Transcript ID.--transcript(required): Transcript content in JSON list format.
create-screenshot-at-timecode
Creates a screenshot from a video asset at a specific timecode.
Options:
--id,--url,--object-key: Asset identifier (must be a video).--time-code(required): Timecode for the screenshot. Format:hh:mm:ss;ff.
start-workflow
Starts a workflow on one or more assets.
Options:
--action-arguments(required): Arguments to pass to the workflow.--target-ids(optional, multiple): Asset IDs.--target-urls(optional, multiple): Nomad Media URLs.--target-object-keys(optional, multiple): Object-keys (requires default bucket).
share-asset
Shares an asset with Nomad Media users or external users.
Options:
--id,--url,--object-key: Asset identifier.--nomad-users(optional): Nomad Media users in JSON list format.--external-users(optional): External users in JSON list format.--shared-duration-in-hours(optional): How long the share link is valid.
Asset Inspection Commands
get-asset-child-nodes
Gets the child nodes of a folder asset.
Options:
--id,--url,--object-key: Asset (folder) identifier.--folder-id(optional): Folder ID.--sort-column(optional): Column to sort by.--is-desc(optional): Sort descending.--page-index(optional): Page index.--page-size(optional): Page size.
get-asset-parent-folders
Gets the parent folders of an asset.
Options:
--id,--url,--object-key: Asset identifier.--page-size(optional): Page size for results.
get-asset-metadata-summary
Gets the metadata summary of an asset.
Options:
--id,--url,--object-key: Asset identifier.
get-asset-manifest-with-cookies
Gets the streaming manifest of an asset with signed cookies.
Options:
--id,--url,--object-key: Asset identifier.--cookie-id(required): Cookie ID.
get-asset-screenshot-details
Gets screenshot details for a video asset.
Options:
--id,--url,--object-key: Asset identifier (must be a video).--segment-id(optional): Segment ID.--screenshot-id(optional): Screenshot ID.
get-asset-segment-details
Gets segment details for a video asset.
Options:
--id,--url,--object-key: Asset identifier (must be a video).--segment-id(required): Segment ID.
get-user-uploads
Gets in-progress or completed user upload sessions.
Options:
--include-completed-uploads(optional): Whether to include completed uploads. Default:True.
get-user-upload-parts
Gets the parts of a multipart upload session.
Options:
--upload-id(required): Upload session ID.
update-asset
Updates asset metadata fields.
Options:
--id,--url,--object-key: Asset identifier.--display-name(optional): Display name.--display-date(optional): Display date.--available-start-date(optional): Availability start date.--available-end-date(optional): Availability end date.--custom-properties(optional): Custom properties in JSON format —{"key": value}.
update-asset-language
Updates the language of an asset.
Options:
--id,--url,--object-key: Asset identifier.--language-id(required): Language ID.
records-asset-tracking-beacon
Records a tracking beacon for an asset.
Options:
--id,--url,--object-key: Asset identifier.--tracking-event(required): Tracking event name.--live-channel-id(required): Live channel ID.--content-id(optional): Content ID to track alongside the asset.--second(optional): Second mark into the video or ad.
Annotation Commands
create-asset-annotation
Creates a timed annotation on a video asset.
Options:
--id,--url,--object-key: Asset identifier (must be a video).--start-time-code(required): Start timecode. Format:hh:mm:ss;ff.--end-time-code(required): End timecode. Format:hh:mm:ss;ff.--properties(required): Annotation properties in JSON dict format —{"key": value}.
get-annotations
Gets all annotations for a video asset.
Options:
--id,--url,--object-key: Asset identifier (must be a video).
update-annotation
Updates an existing annotation.
Options:
--id,--url,--object-key: Asset identifier (must be a video).--annotation-id(required): Annotation ID.--start-time-code(optional): New start timecode. Format:hh:mm:ss;ff.--end-time-code(optional): New end timecode. Format:hh:mm:ss;ff.--title(optional): Annotation title.--summary(optional): Annotation summary.--description(optional): Annotation description.
delete-asset-annotation
Deletes an annotation from a video asset.
Options:
--id,--url,--object-key: Asset identifier (must be a video).--annotation-id(required): Annotation ID.
import-annotations
Imports a set of annotations for a video asset.
Options:
--id,--url,--object-key: Asset identifier (must be a video).--annotations(required): Annotations in JSON list format.
Ad-Break Commands
create-asset-ad-break
Creates an ad break marker on a video asset.
Options:
--id,--url,--object-key: Asset identifier (must be a video).--time-code(required): Ad break timecode. Format:hh:mm:ss;ff.--tags(optional, multiple): Tags in JSON list format —{"id": {id}, "description": {description}}.--labels(optional, multiple): Labels in JSON list format.
get-asset-ad-break
Gets an ad break from a video asset.
Options:
--id,--url,--object-key: Asset identifier (must be a video).--ad-break-id(required): Ad break ID.
update-asset-ad-break
Updates an ad break on a video asset.
Options:
--id,--url,--object-key: Asset identifier (must be a video).--ad-break-id(required): Ad break ID.--time-code(required): New timecode. Format:hh:mm:ss;ff.--tags(optional, multiple): Tags in JSON list format.--labels(optional, multiple): Labels in JSON list format.
delete-asset-ad-break
Deletes an ad break from a video asset.
Options:
--id,--url,--object-key: Asset identifier (must be a video).--ad-break-id(required): Ad break ID.