Interface IMediaMetadataArgs

Options specifying the metadata to set for an uploaded media item.

Only the options that are specified are sent. Omitted options keep their default values.

interface IMediaMetadataArgs {
    aiGenerated?: boolean;
    allowDownload?: boolean;
    altText?: string;
    blockGrokEdit?: boolean;
    id: string;
    sensitiveWarning?: SensitiveWarning[];
}

Implemented by

Properties

aiGenerated?: boolean

Whether to mark the media item as AI-generated.

allowDownload?: boolean

Whether other users are allowed to download the media item.

altText?: string

The alternative text (description) of the media item.

blockGrokEdit?: boolean

Whether to block Grok from editing the media item.

id: string

The id of the uploaded media item.

sensitiveWarning?: SensitiveWarning[]

The sensitive content warnings to attach to the media item.