Skip to main content
GET
Generate a signed download URL for a file variant

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

The unique ID of the file.

Query Parameters

variant
enum<string>
default:original

Which file variant to sign. If not provided, defaults to original.

Available options:
original,
redact,
ocr
expires
integer
default:3600

Expiration time in seconds for the signed URL. Must be between 60 and 86400 seconds.

Required range: 60 <= x <= 86400
filename
string

Optional filename override used in the Content-Disposition header.

Response

Signed URL successfully generated.

url
string

Presigned S3 URL.

variant
enum<string>

The actual variant that was signed (may differ if fallback occurred).

Available options:
original,
parsed,
ocr
bucket
string

S3 bucket containing the file.

key
string

S3 object key.

expires
integer

Expiration time in seconds.