Sign in
entity-files

Preview Entity File

How to render this file, decided from its BYTES.

kind: "blob" — the only payload a client renders natively — is returned only for magic-verified PDFs and images. Everything unrecognized, including anything markup-shaped, is unsupported and gets a download button.

get/api/v1/entity-files/{file_id}/preview

Path parameters

file_idstring uuid required

Query parameters

app_idstring uuid nullable
embed_host_app_idstring uuid nullable
sheetstring nullable

Response

Successful Response

kind'blob' | 'sheet' | 'unsupported' required
mode'pdf' | 'image' nullable
sheetsstring[]
activestring nullable
columnsstring[]
truncatedboolean

Changes

Changed in 1 of the 12 revisions of this API.1