idstring uuid required
The unique identifier of the shareable asset
file_idstring uuid required
The ID of the file the shareable asset belongs to
file_segment_idstring uuid
The ID of the file segment the shareable asset belongs to (optional)
titlestring
The title of the shareable asset
descriptionstring
The description of the shareable asset
metadataobject
The metadata of the shareable asset
visibility'public' | 'private'
The visibility of the shareable asset. 'public' assets are viewable by anyone with the link; 'private' assets are restricted to members of the owning account and stream via a signed, token-gated playback url.
link_preview'none' | 'full' | 'player' required
Controls rich link-preview (Open Graph) metadata for unfurl bots on private shares. 'none' (default) emits no preview metadata; 'full' emits title, description, and thumbnail; 'player' additionally lets the share play inline when its link is unfurled by the Cloudglue Slack app — anyone who can see the Slack message can play it. Public shares always emit full metadata (and unfurl playable where the Slack app is installed) regardless of this value.
preview_urlstring
The thumbnail url of the shareable asset
media_download_urlstring
The signed media download url of the shareable asset. For private assets this url is short-lived (a few minutes) and should be used promptly.
media_download_expires_atnumber nullable
The timestamp of when the media download url will expire
share_urlstring
This is the url that can be used to share the shareable asset. For private assets the page requires sign-in and membership of the owning account.
stream_urlstring
The HLS stream url of the shareable asset. Available when the stream has finished processing. For private assets this is a signed, token-gated url that should be treated as short-lived. When the asset was fetched with a clip window (clip_start/clip_end on GET /share/{id}), the stream plays only that window.
status'pending' | 'processing' | 'completed' | 'failed'
The status of the shareable asset
asset_type'file' | 'file_segment'
The type of asset the shareable asset belongs to
created_atnumber required
The timestamp of when the shareable asset was created
object'share'
Object type, always 'share'