Download

This endpoint is used to download a shared file.

Endpoint: /files/download/{fileId}

Method: GET (Since it's a download, GET is the appropriate method)

Path Parameters:

fileId (required): The ID of the file to download. Example: b34nlb44l4v2d1iqdh8ofdl2

Request Body Parameters:

(This endpoint does not use a request body as it's a GET request)

Example Request:

GET /files/download/b5h86j5dkl7m0rnylnkt3kfh

This request initiates the download of the shared file with the ID b34nlb44l4v2d1iqdh8ofdl2.

Response Codes:

200 OK: File download successful. The file content will be in the response body.

400 Bad Request: Invalid request parameters.

401 Unauthorized: User is not authorized to download this file. (Important for shared files)

404 Not Found: File not found.

500 Internal Server Error: Server error.

Important Considerations for Downloads:

Content-Type Header: The response should include the appropriate Content-Type header (e.g., application/pdf, image/jpeg, application/octet-stream for generic binary data) to indicate the file's MIME type.

Content-Disposition Header: The Content-Disposition header should be used to suggest a filename to the browser. For example: Content-Disposition: attachment; filename="downloaded_file.pdf"

Error Handling: Clear error messages are essential, especially 401 Unauthorized to indicate access issues with shared files.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request

Request samples

Responses