helpers

Load a preview of the file

Changed on
get/w/{workspace}/job_helpers/load_file_preview

Request

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

Path parameters

workspacestring required

Query parameters

file_keystring required
file_size_in_bytesinteger
file_mime_typestring
csv_separatorstring
csv_has_headerboolean
read_bytes_frominteger
read_bytes_lengthinteger
storagestring
s3_resource_pathstring

When set, load the file preview from this object storage resource instead of the workspace storage

Response

FilePreview

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

Changes