shortlink

Methods and types of the `shortlink` namespace (`client.shortlink` / `bot.shortlink`).

Interfaces

Property	Type	Description
`fileName`	`string`	-
`mediaKeyPath`	`string` \| `null`	Original media keyPath used as fallback when no HLS manifest is available.
`mediaType`	`string`	-
`mode?`	`"embed"` \| `"embed-download"`	Mode of the underlying public link: 'embed' (no download) or 'embed-download' (download allowed alongside embed). 'download' never appears — that mode blocks the embed-files endpoint entirely. Optional for backward compatibility with older API versions; treat absence as 'embed-download'.
`posterKeyPath`	`string` \| `null`	Poster image keyPath for video assets (explicit poster, falling back to largest thumbnail). Null when none exists.
`streamKeyPath`	`string` \| `null`	HLS manifest keyPath (e.g. "workspaces/.../stream/index.m3u8"), null if not yet processed.
`waveformKeyPath?`	`string` \| `null`	Pre-computed waveform peaks JSON keyPath for audio assets. Null for video / when no peaks file exists.

Property	Type	Description
`fileName`	`string`	-
`mediaType`	`string`	-
`mimeType?`	`string` \| `null`	Mime type of the original media file, when known.
`mode?`	`"download"` \| `"embed"` \| `"embed-download"`	Capability mode of the link. The download page uses this to decide whether to render the inline preview (`embed-download`), the embed-only message (`embed`), or auto-download (`download`). Optional for backward compatibility with older API versions; treat absence as `embed-download`.
`previewKeyPath?`	`string` \| `null`	For image assets: the keyPath of the image file, used to render an inline preview on the download page. Null for non-image assets (video / audio previews are iframed from the embed page; files render an icon).
`status`	`string`	-
`token`	`string`	-

Property	Type
`deepLink`	`string`
`resourceId`	`string`
`resourceType`	`"asset"` \| `"project"` \| `"workspace"` \| `"chatMessage"` \| `"chatSubmission"`
`visibility`	`"creator"` \| `"reviewer"` \| `null`

function default(client): {
  resolveShortLink: Promise<ResolveShortLinkResponse>;
};

Defines short link related methods for the NuramaClient.

Parameter	Type	Description
`client`	`default`	The NuramaClient instance.

An object containing the short link related methods.

Name	Type	Description
`resolveShortLink()`	(`code`) => `Promise`<`ResolveShortLinkResponse`>	Resolves a short link code to its full deep link path. This endpoint is publicly accessible and does not require authentication.