latestOpenAPI 3.0.32026-08-15374594.4 KB

4d61b97f1e97

File

downloadFile

Generate a pre-signed download URL for a file.

The returned URL is valid for a limited time (typically 15 minutes) and can be used to download the file directly.

Download attribution (x-track-*): any query parameter whose name starts with x-track- is treated as opaque tracking metadata and signed into the returned URL, so it shows up in the S3 access logs / CloudTrail data events when the link is actually opened. This is a generic, service-agnostic channel — e.g. the customer portal sends x-track-portal-id and x-track-contact-id. Only the x-track- namespace is forwarded; the values cannot affect how S3 resolves or serves the object. Parameter names must match ^x-track-[a-z0-9](?:[a-z0-9_-]{0,38}[a-z0-9])?$, values are capped at 256 characters, and at most 10 such parameters are honoured (see the x-track parameter below).

get/v1/files/{id}/download

Path parameters

string required

Empty string (used when file ID not yet assigned)

OR
string uuid required

Valid UUID v4

The UUID of the file entity

Query parameters

versioninteger

Index of the file version to download (0 = latest)

attachmentboolean

Controls the Content-Disposition header. Set to true to trigger browser download dialog, false to display inline.

x-trackobject

Download-attribution channel. Provide any number of query parameters whose names start with x-track- (e.g. x-track-portal-id, x-track-contact-id); each is signed into the pre-signed URL verbatim so the download is recorded in the S3 access logs / CloudTrail data events. Only the x-track- namespace is forwarded — values cannot affect how S3 resolves or serves the object. Parameter names must match ^x-track-[a-z0-9](?:[a-z0-9_-]{0,38}[a-z0-9])?$, values are capped at 256 characters, and at most 10 such parameters are honoured.

Response

Pre-signed download URL

download_urlstring uri

Pre-signed S3 URL valid for downloading the file

Example response

{
  "download_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123"
}