app

Load a preview of an s3 file on-behalf of the app author (deployed app)

Changed on
get/w/{workspace}/apps_u/load_file_preview/{path}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/w/{workspace}/apps_u/load_file_preview/{path}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required
pathstring required

Query parameters

file_keystring required
file_size_in_bytesinteger
file_mime_typestring
csv_separatorstring
csv_has_headerboolean
read_bytes_frominteger required
read_bytes_lengthinteger required
storagestring
sigstring

HMAC signature of a presigned S3 object (bypasses the app provenance gate)

expstring

Expiry timestamp of a presigned S3 object signature

Response

FilePreview

msgstring
contentstring
content_type'RawText' | 'Csv' | 'Parquet' | 'Unknown' required

Changes