files

Retrieve a file and get a presigned download URL

Returns file metadata and, for clean-scanned files, a short-lived presigned download URL scoped to the owning sales channel. Files that are still scanning or quarantined are not downloadable.

get/api/v1/files/{file_id}

Request

  • Base URL: https://dev-api.truemed.com
  • URL: https://dev-api.truemed.com/api/v1/files/{file_id}
  • Auth: API key in header x-truemed-api-key

Path parameters

file_idstring required

The public file identifier.

Response

Successful response

content_typestring required

The file's MIME type, e.g. application/pdf.

download_urlstring required

Short-lived presigned download URL (5 minutes). Always present in a 200 response; non-clean files return 409 rather than a 200 with this field absent.

file_idstring required

The public file identifier.

filenamestring required

The stored filename.

scan_status'pending_scan' | 'clean' | 'quarantined' required

Malware-scan gate. Evidence attach + download only accept Clean files.

size_bytesinteger required

The file size in bytes.

Changes

No recorded changes to this operation across all 1 revision of this API.