Skip to navigation
Files

Get a file's content

View as Markdown

Fetch a source file’s content for inspecting raw instrument output.

Returns a presigned download URL plus a best-effort UTF-8 text preview of the first 64 KiB of the file, regardless of total size. Fetch the full bytes via the URL when needed.

Requires an API key with the read scope.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

file_idstringRequired

Response

OK
file_idstring
file_namestring or null
size_kilobytesinteger or null
download_urlstring

Presigned URL to fetch the full file (e.g. via the SDK).

text_previewstring or null

Best-effort UTF-8 decode of the start of the file, or null if skipped.

preview_truncatedboolean
True if the file is longer than the inlined preview.
preview_skipped_reasonstring or null

Why an inline preview was not returned (e.g. a storage read failed).

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error