Skip to navigation
API ReferenceFiles

Get a time-limited download link for a file

Returns a short-lived presigned URL to download the file’s contents, together with its filename, content type and size.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

file_idstringRequiredformat: "file_.+"

Headers

X-Platform-IdstringOptional

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Response

OK
urlstring

The URL to download the file from. Valid until expires_at.

expires_atdatetime
The date and time the download URL expires.
filenamestring
The name of the file.
content_typestring
The MIME type of the file.
content_lengthlong
The size of the file in bytes.

Errors

404
Not Found Error