Sign in

v1

latestOpenAPI 3.0.12026-07-14182037.3 KB
Files

Get signed URL to access private file.

Generates signed URL that allows temporary access to a private file.

get/files/v3/files/{fileId}/signed-url

Path parameters

fileIdstring required

ID of file.

Query parameters

size'thumb' | 'icon' | 'medium' | 'preview'

For image files. This will resize the image to the desired size before sharing. Does not affect the original file, just the file served by this signed URL.

expirationSecondsinteger

How long in seconds the link will provide access to the file.

upscaleboolean

If size is provided, this will upscale the image to fit the size dimensions.

Response

successful operation

expiresAtstring date-time required

Timestamp of when the URL will no longer grant access to the file.

extensionstring required

Extension of the requested file.

heightinteger

For image and video files. The height of the file.

namestring required

Name of the requested file.

sizeinteger required

Size in bytes of the requested file.

typestring required

Type of the file. Can be IMG, DOCUMENT, AUDIO, MOVIE, or OTHER.

urlstring required

Signed URL with access to the specified file. Anyone with this URL will be able to access the file until it expires.

widthinteger

For image and video files. The width of the file.