Public

Read file

get
/public/files/{file}/read

Retrieves public details of a file by its ID. No authentication required.

Path parameters
filestringRequired

The ID of the file to read.

Example: 68679c0786ad78162a99d6af
Responses
chevron-right
200

File details retrieved successfully.

application/json
get
/public/files/{file}/read

Download file

get
/public/files/{file}/download

Downloads a public file by its ID. No authentication required. For encrypted files, provide stream=false in query params and a Passphrase header. Optional password header can be used for password-protected files. An optional key query parameter can be provided as a temporary token for file access.

Path parameters
filestringRequired

The ID of the file to download.

Example: 6853e14d78e8cc3e4c66fb
Query parameters
streambooleanOptional

Set to false to download encrypted files. Defaults to true for streaming public files. Required if Passphrase is provided.

Example: false
keystringOptional

Optional temporary token for downloading files.

Example: abc123xyz
Header parameters
PassphrasestringOptional

Passphrase required to decrypt an encrypted file. Must be provided with stream=false for encrypted file downloads.

Example: Test123!
passwordstringOptional

Optional password for password-protected files.

Example: Password123!
Responses
chevron-right
200

File downloaded successfully. Returns the file content.

No content

get
/public/files/{file}/download

No content

Last updated