REST API ReferenceEndpointsFiles

Disable public preview

Disable public preview for a file. Revokes unauthenticated streaming access. The file's signed URLs for authenticated access remain functional. Returns the updated file.

Authentication

AuthorizationBearer
API key from [app.videogen.io/developers](https://app.videogen.io/developers). The full key is only shown once when you create it.

Path parameters

fileIdstringRequired

Response

File with public preview disabled
fileIdstring

File id (e.g. vg_file_...).

scopeenum

File scope.

  • GLOBAL: user-uploaded or standalone generated files that persist indefinitely.
  • PROJECT: project-specific files (e.g. text-to-speech clips in a generated project).
  • EXPORT: project exports.
  • TEMPORARY: short-lived files guaranteed to be available for 24 hours, after which they may be archived at any time. Not analyzed (no description, transcript, or embedding).
Allowed values:
typeenum or null
File type. Null when the file is still being processed and the type has not yet been determined.
Allowed values:
displayNamestring
Display name for the file.
descriptionstring or null
durationSecondsdouble or null
Duration in seconds for video and audio files. Null for images.
transcriptstring or null
Transcript text for video and audio files, when available. Null for images or when no transcript has been generated.
thumbnailSourceobject or null
Thumbnail image source. Populated after hydration.
previewSourceobject or null

Preview rendition source (720p for video, resized for images). Populated after hydration.

downloadSourceobject or null

Highest-quality downloadable rendition. Populated after hydration.

hlsSourceobject or null

Private HLS streaming source. Populated for video and audio files once streaming renditions are ready. Uses a signed token; treat like other signed sources.

isPublicPreviewEnabledboolean

Whether public preview is enabled for this file. When true, publicHlsUrl and publicPlaybackId are populated.

publicHlsUrlstring or null

Public HLS streaming URL. Only present when isPublicPreviewEnabled is true. Does not require authentication or signed tokens.

publicPlaybackIdstring or null

Encoded public playback id (e.g. vg_play_...). Pass this to the @videogen/player or @videogen/player-react packages. Only present when isPublicPreviewEnabled is true.

sourceToolTypestring

Tool type that generated this file (e.g. GENERATE_IMAGE, TEXT_TO_SPEECH). Only present when the file was created by a tool execution.

sourceToolExecutionIdstring

Execution id of the tool call that generated this file (e.g. vg_exec_...). Only present when the file was created by a tool execution.