EPepilot
Preview

previewFile

Changed on

Generate a thumbnail preview for a file entity.

Supported file types include images (PNG, JPEG, GIF, WebP), PDFs, and common document formats. The preview is returned as an image (PNG or JPEG).

Tip: Use with CookieAuth to embed previews directly in <img> tags.

get/v1/files/{id}/preview

Request

  • Base URL
    https://file.sls.epilot.io
  • URL
    https://file.sls.epilot.io/v1/files/{id}/preview
  • Auth
    • HTTP bearer
    • or API key in cookie token

Path parameters

string required

Empty string (used when file ID not yet assigned)

OR
string uuid required

Valid UUID v4

The UUID of the file entity

Query parameters

versioninteger

Index of the file version to preview (0 = latest)

winteger

Desired width in pixels (maintains aspect ratio if only width is specified)

hinteger

Desired height in pixels (maintains aspect ratio if only height is specified)

Response

Generated thumbnail image

Changes